-
Notifications
You must be signed in to change notification settings - Fork 5
Repository Guidelines
The main branch always mirrors the Pypi CRIPT installation page.
The develop branch is what is staged for the next release. When aiming to contribute to the repository, the developer should always branch off of the develop branch into a new branch, write their code, and make a pull request to merge the code into the develop branch.
Merging develop branch into main branch is considered a new release
If a branch is no longer in use please consider deleting it to not have extra branches just hanging around forever, and our repository is always clean. Please feel free to have as many branches as you possibly need, there are never any limits on branches and branching is a good idea and a great way to test and try out new ideas and build great code.
Pull requests should have good description, so anyone seeing it knows what the code does and does not do.
There should be appropriate tests done for each pull request and the code submitted should be secure.
After the branch the pull request is submitted on is merged in, be sure to delete your branch if you no longer need it to keep the repository clean and not have a lot of unused branches hanging around.
If there are you have a lot of commits consider "squash and merge" to make a single commit to the develop or master branch to keep the commit history clean. Ideally, we should strive for a meaningful commit history that is easy to follow, undo, and do.
After merging in the branch, consider deleting the branch if you are no longer using it. Ideally, we should strive to keep our repository branches clean, and only have the branches that we are using and not have extra branches just hanging around.
Every release should have good clear release notes within the announcement section and in the releases section