This is very much an active project so any and all contributions are welcome, even just finding issues!
Reporting Issues
All issues should be tracked at GitHub, with enough information to reproduce the issue.
See the contrubiton docs for expectations when creating issues.
Code Contributions
This repository is based around the Git Flow workflow, using feature/hotfix/bugfix branches and pull requests to manage incoming changes and fixes. Generally speaking you can follow a similar guidance as Cake itself (found here), which can be summarised as follows:
- Find a change or fix you want to implement
- Fork the repo
- Workflow for new features
- Create a new branch named
feature/<your-feature-name>and make your changes - Open a PR from your feature branch against the
developbranch (include the GitHub issue number)
- Create a new branch named
- Workflow for bug fixes in the latest stable version
- Create a new branch named
hotfix/<your-bugfix-name>and make your changes - Open a PR from your hotfix branch against the
masterbranch (include the GitHub issue number)
(This will be re-targeted to a different branch when accepted)
- Create a new branch named
- Workflow for bug fixes in an unpublished version of Cake.Warp
- Create a new branch named
bugfix/<your-bugfix-name>and make your changes - Open a PR from your bugfix branch against the
developbranch (include the GitHub issue number)
- Create a new branch named
- Success! I will provide feedback if needed, or just accept the changes directly and they should appear in the next release
License
Note that this project (and all contributions) fall under the MIT License terms.