If you're planning on contributing to this repository there are two things you need to read first:
- Thank you for being awesome ✌
- Please read the following guidelines so that you have all the necessary information to correctly perform pull requests.
Important: Before you start developing something (anything), please submit an issue first so that our team can evaluate if your contribution makes sense within that context (we can already be working on something similar to your contribution, for example).
To submit your contribution you’ll need to use Git (if you’ve never used it before, please follow this helpful link) or directly use GitHub. Now, please, follow the next steps:
- To make changes without affecting the original project please fork a copy of the current repository. This clones the master branch (the current main code) to a new branch for you to work on;
- Make any change, correction or implementation you intend;
- Commit (with a clear, simple and direct message resuming your contribution) and push your changes to the new forked branch you’ve created. You can push multiple commits to the same branch to distinguish modifications;
- Open a new pull request with a clear message summing up every commit you’ve made. Basically, this creates a request for our development team review your code modifications and, if accepted, merge it into the master branch;
- Your Pull Request will be merged once you have the sign-off of our development team.
In order to keep up with all our developments and contributions you can “Watch” (or “Star”) our repositories. If you prefer, we also have a weekly newsletter that you can subscribe right here.
If, for any reason, you have doubts regarding this process feel free to email us at support@omnialowcode.com. We'll be happy to help.