<aside> 💡 READ ME This guide is for anyone that would like to be a collaborator on the pyRevit repository. The intention is to set a few ground rules so we can work together asynchronously and don’t have to send emails back and forth. I have heard no-one really likes emails.

We have tried to keep this short so please read the sections below carefully.

We have highlighted the MOST IMPORTANT stuff

</aside>

https://github.com/eirannejad/pyRevit

Important Documents

These documents are at the root of the repository

• Code of conduct → CODE_OF_CONDUCT.md
• Credit others when you use their project → CREDITS.md
• Add your name as a collaborator → CONTRIBUTING.md

Important Files

This is how the pyRevit repository is organized:

• bin/
  • engines/
• dev/
  • pyRevitLabs. assemblies
• extensions/
• pyrevitlib/
  • pyrevit
  • rjm/
  • rpw/
  • rpws/
  • rsparam/
• site-packages/
• static/

pyRevitFile

Building pyRevit Source

This is a bit more involved so here a pretty page that is just about building pyRevit. You don’t have to do this unless you are making changes to the pyRevit runtime that is in C#, or merging PRs that includes such changes. Make sure to build and test locally and then push to origin.

Building pyRevit Source

Committing Changes

When working on pyRevit repository, you should create a specific branch for the changes that you are making. After making and committing all your changes, your branch can be squish-merged into develop. This way there would a single commit for every bug fix, feature, or other changes. This makes it very easy to find when a specific change has been introduced to pyRevit and “revert” the changes later if necessary.

We follow a dev/* pattern for development branch names:

• For bugs dev/000 where 000 is the issue number
• For PRs dev/pr000 where 000 is the PR number

Not following this pattern does not break anything, but it makes harder for others to see the upcoming changes

Merging Pull Requests (PR)

Reviewing changes in a PR is important. You want to make sure:

• The proposed changes actually work and compile