-
Notifications
You must be signed in to change notification settings - Fork 41
Getting started with contribution
🌿Git Brunching🌿 is an Open Source Friendly project!
To ensure that work is carried out in a manageable way, we've established a development process that starts from creating or accepting an issue all the way through to getting a pull request merged! Below you'll find a brief overview of the contribution process, as well as links to more detailed pages.
You should note that development isn't the only way that you can contribute towards this project. On top of developers, we're always looking for people to:
- Identify bugs or possible features and open comprehensive issues detailing them.
- Review issues to ensure they contain enough information to begin work on.
- Contribute towards the project wiki.
- Perform code reviews for pull requests.
- Create test cases
However you decide to contribute, you should read through the rest of this document to familiarize yourself with the workflow.
The first thing you're going to want to familiarize yourself with is issues and labels.
Issues provide a way to keep track of a unit of work, and ensure that the entire development process can be logged, tracked and moved along.
Labels identify where an issue is in its life cycle (ie; when it is pending review) and also allow you to sort by label in order to find issues that might suit your skill set.
To familiarize yourself with how issues are used in Git Branching, head over to this page to find out more!
If you pick up an issue requiring development, you're going to need to learn about the fork-and-pull method that we employ
You can see an overview on how to fork and clone your own copy of the repository, what branch name conventions to use, and how to create a pull request here.
Once you've successfully created your own working branch, you'll need to perform a few extra steps in order to get your development environment up and running.
You can view the full steps, as well as some tips on how to properly contribute towards the project on this page.
To ensure that your code gets merged as quickly and with as little reviews as possible, we encourage you to have a look at our code conventions page found here.