General Guidelines for committing code to GitHub |
All of the below guidelines are just suggestions. They are not meant to create additional "red tape" during the normal development process. If you find they are getting in the way, let us know, we can always change them! Development processes and best practices change over time, and these guidelines should be no different. |
By "Master" we are not only referring to DSpace/DSpace in GitHub. We're also referring to the "Master" branch of any other production-quality, out-of-the-box GitHub projects (e.g. DSpace/dspace-services, DSpace/dspace-api-lang, etc.) |
The GitHub Master Branch is one of the few places that needs to remain well managed. As we all fork it and/or create Pull Requests from it, it can be detrimental to us all if incomplete or extremely buggy code is committed. Obviously, mistakes happen (and we've all made them), so don't worry if you accidentally commit/merge something you didn't mean to (just try to roll it back as soon as you notice it). Here are the few rules we try to follow when committing code to Master Branch: