Contributions are welcomed to our projects.
How to contribute
If you want to contribute code. Please be sure to create an issue first with the chosen project.
Pull request best practices
Please follow these steps:
Step 1: File an issue
Before writing any code, please create an issue stating the problem you want to solve or the feature you want to implement. This allows us to give you feedback before you spend any time writing code. There may be a known limitation that can’t be addressed, or a bug that has already been fixed in a different way. The issue allows us to communicate and figure out if it’s worth your time to write a bunch of code for the project.
Step 2: Fork this repository in GitHub
This will create your own copy of our repository.
Step 3: Add the upstream source
The upstream source is the project under the Open Code Box git on GitHub. To add an upstream source to a project, type:
git remote add upstream firstname.lastname@example.org:opencodebox.org/"projectname.git"
This will come in useful later.
Step 4: Create a feature branch
Create a branch with a descriptive name, such as add-search.
Step 5: Push your feature branch to your fork
As you develop code, continue to push code to your remote feature branch. Please make sure to include the issue number you’re addressing in your commit message, such as:
git commit -am "Adding search (fixes #123)"
This helps us out by allowing us to track which issue your commit relates to.
Keep a separate feature branch for each issue you want to address.
Step 6: Rebase
Before sending a pull request, rebase against upstream, such as:
git fetch upstream git rebase upstream/master This will add your changes on top of what’s already in upstream, minimizing merge issues.
Step 7: Run the tests
Make sure that all tests are passing before submitting a pull request.
Step 8: Send the pull request
Send the pull request from your feature branch to us. Be sure to include a description that lets us know what work you did.