$ git checkout -b contributing-guide masterIf the plugin does not already include a 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 git branch for your local work with the command:
$ git checkout -b contributing-guide masterThe 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:
Commit that change:
$ git add CONTRIBUTING.md
$ git commit -m "Add a contributing guide"Push the change to GitHub:
$ git push origin --set-upstream contributing-guide
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote:
remote: Create a pull request for 'contributing-guide' on GitHub by visiting:
remote: https://github.com/user/your-plugin/pull/new/contributing-guide
remote:
To github.com:user/your-plugin.git
* [new branch] contributing-guide -> contributing-guide
Branch 'contributing-guide' tracking remote branch 'contributing-guide'.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.