Community made patches, bug reports and contributions are always welcome and are crucial to ensure PuPHPet remains the #1 GUI tool to set up Virtual Machines for Web development. This should be as easy as possible for you but there are few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a Pull Request.
- You need a GitHub account
- Submit an issue ticket for your issue, assuming one does not already exist.
- Clearly Describe the issue including steps to reproduce when it's a bug.
- Ensure to paste the contents of your
puphpet/config.yamlfile! - Ensure to mark
xxxxif you have sensitive information (passwords, api keys, etc).
- Fork the repository on GitHub
- In your forked repository, create a topic branch for your upcoming patch.
- Usually this is based on the master branch.
- Create a branch based on master;
git branch fix/master/my_contribution masterthen checkout the new branch withgit checkout fix/master/my_contribution. Please avoid working directly on themasterbranch.
- Make commits of logical units and describe them properly.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - If possible, submit tests to your patch/new feature so it can be tested easily.
- Assure nothing is broken by running all the tests.
- Push your changes to a topic branch in your fork of the repository.
- SQUASH COMMITS INTO A SINGLE COMMIT
- Open a pull request to the original repository and choose the right original branch you want to patch.
- If not done in commit messages (which you really should do) please reference and update your issue with the code changes.
- Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.