Add a contributing guide
If the plugin does not already include a contributing guide and if it would benefit from more detail than is provided in the default contributing guide, add a contributing guide so that others understand how to help with plugin development.
Look for existing contributing instructions in files like README.md
.
Move the content from the README.md
file to the CONTRIBUTING.md
file so that the README file stays focused on user documentation.
Create a branch
In a local copy of your fork of the plugin repository create a git branch for your work with the command:
git checkout -b {task-identifier} master
The contributing guide often includes instructions to:
-
Compile and run automated tests
-
Run the plugin in a development environment
-
Report code coverage of the plugin and its tests
-
Report static analysis results
Refer to the contributing guides of other plugins for common examples, like:
Create a pull request
Commit that change:
git add {modified-files}
git commit -m "{task-description}"
Push the change to GitHub:
git push origin --set-upstream {task-identifier}
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0 remote: remote: Create a pull request for '{task-identifier}' on GitHub by visiting: remote: https://github.com/user/your-plugin/pull/new/{task-identifier} remote: To github.com:user/your-plugin.git * [new branch] {task-identifier} -> {task-identifier} Branch '{task-identifier}' tracking remote branch '{task-identifier}'.
Notice that the output of the command includes the URL, which can be used to open a pull request. Copy that URL in your web browser and submit a pull request.