Contributions are what make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are greatly appreciated.
Here are some ways you can help:
- Pick one of the unassigned issues currently opened.
- Select items from the Project Roadmap you are interested in.
- Submit your ideas on how CodePrimer could help you.
- Add support for other programming languages by creating the appropriate Twig template
If you want to contribute code changes (bug fix, feature, templates) to CodePrimer, follow these steps:
- Fork this repository
- Create your feature branch:
git checkout -b feature/AmazingFeature - Make your changes and commit them with a reference to the issue number being addressed:
git commit -m 'Closes #<issue_number> - Add some AmazingFeature' - Push your local branch back to GitHub:
git push origin feature/AmazingFeature - Create the Pull Request against the master branch on the
clabonte/codeprimerrepository
If you are interested to contribute on a frequent basis, feel free to contact me so I can add you as a repository member.
In order to maintain the quality of this project, important rules must be followed for a Pull Request to be considered:
- Make sure all test cases are passing by running the following command:
composer phpunit - Make sure your code is following the project's coding standards by running the following command:
composer format-code - Make sure you maintain the project's code coverage above 90% (ideally 95%)
The above rules are being strictly enforced via GitHub workflows for any Pull Request opened against the master branch.
Thanks for your interest in CodePrimer!!