Adding a code of conduct to your project
Adopt a code of conduct to define community standards, signal a welcoming and inclusive project, and outline procedures for handling abuse.
A code of conduct defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for how to engage in a community, see the Open Source Guide.
Before adopting a code of conduct for your project:
- Research different codes of conduct designed for open source projects. Choose one that reflects your community's standards.
- Consider carefully whether you are willing and able to enforce it.
You can create a default code of conduct for your organization or user account. For more information, see "Creating a default community health file."
GitHub provides templates for common codes of conduct to help you quickly add a code of conduct to your project. If the code of conduct you want to use isn't available in the list, you can paste the contents of the code of conduct that you have selected into the text area of the CODE_OF_CONDUCT.md file and commit the file to your branch. Be sure to follow the attribution guidelines from the source of your code of conduct as needed. Add the CODE_OF_CONDUCT.md file to the root,
- On GitHub, navigate to the main page of the repository.
- Above the file list, click Create new file.
- In the file name field, type CODE_OF_CONDUCT.md.
- Click Choose a code of conduct template.
- On the left side of the page, select a code of conduct to preview and add to your project.
- On the right side of the page, complete the fields to populate the selected code of conduct with the appropriate information.
- Click Review and submit.
- Review the contents of the code of conduct that's in the text area.
- At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
- Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is
master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
- Click Propose new file.