Skip to content

Latest commit

 

History

History
34 lines (29 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

34 lines (29 loc) · 1.93 KB
Raw

Submitting issues

You can report bugs on this page Please describe you issues as clearly as possible. eg. :

  • Copy paste error message if you got one
  • Describe the context which lead you to the issue step by step
  • Indicate your Revit, pyRevit and pyRevitMEP version

Contributing to documentation (video, text etc…)

Videos

There is some videos tutorial to describe how scripts works but many are missing. You can also translate it in your own language. There is already 1 video in french. Add video to your own youtube channel or send it to me. I will then add it to playlist depending on language (new playlist if new language). Videos must be under Creative Commons CC BY License Creative Commons Attribution 4.0 International License or any compatible licence.

Text

I try to comment code as much as possible and to use type hints to improve auto control available in IDE as pyCharm but there is no real standalone documentation produced yet. You might want to generate one using Sphinx or simple README.md in each folder, or just correct typos ?

Contributing to source code

Want to contribute to source code ? Great, you can :

  • Fork this repo, add code you would like to add, test it and send pull request
  • Get in touch if you want to discuss your idea You must agree license terms.

You want to help but don't know how to code check Ehsan's course and links on my blog.

UI/UX

Unless you see small valuable improvements. I don't think it worth working on it too much. I suggest to contribute to contribute to a more sustainable/worthy project as FreeCAD.