♥ JustFakeIt and want to get involved? Great! There are plenty of ways you can help!
If you find a bug, have a feature request or even want to contribute an enhancement or fix, please follow the below guidelines so that we can help you out and/or get your code merged quickly.
- Check the GitHub issue tracker to see if anyone else has reported the issue.
- Make sure you are using the latest version of JustFakeIt
- If you are still having an issue, create an issue including:
- Information you will need to reproduce and diagnose the problem
- Discuss any major enhancement with the project moderator.
- Write your Spec and/or Functional tests.
- Write or modify any accompanying documentation.
- Ensure that your tests work and your documentation is complete.
We follow the standard GitHub fork & pull request approach to open source collaboration. You can find an awesome description on how this works on the gun.io blog.
In a nutshell:
- Fork it.
- Create your feature branch (
git checkout -b feature/my-new-feature
). - Commit your changes (
git commit -am 'Add some feature'
) and reference any issues. - Push to your branch (
git push origin my-new-feature
). - Send a new Pull Request describing what you have done and why, in detail.
IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the the terms of the Apache 2.0 license. A copy of this license is provided in the root of the repository.