Skip to content

Commit 5665a1e

Browse files
sophiethekingCopilotfelicitymay
authored
Contributing Guidelines now visible in repository tab and sidebar (#56962)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Felicity Chapman <[email protected]>
1 parent 43bb7e1 commit 5665a1e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ shortTitle: Contributor guidelines
1717

1818
To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. {% ifversion fpt or ghec %}The link to the contributing guidelines also appears on your repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute).{% endif %}
1919

20+
{% ifversion fpt or ghec or ghes > 3.18 %}If your repository includes a `CONTRIBUTING.md` file, {% data variables.product.github %} also surfaces it in two other places to make it easier for contributors to discover:
21+
22+
* A "{% octicon "people" aria-hidden="true" aria-label="people" %} Contributing" tab in the repository overview (next to the "{% octicon "book" aria-hidden="true" aria-label="book" %} README" and "{% octicon "code-of-conduct" aria-hidden="true" aria-label="code-of-conduct" %} Code of conduct")
23+
* A "Contributing" link in the repository sidebar{% endif %}
24+
2025
For the repository owner, contribution guidelines are a way to communicate how people should contribute.
2126

2227
For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues.
@@ -28,7 +33,7 @@ You can create default contribution guidelines for your organization or personal
2833
> [!TIP]
2934
> Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates).
3035
31-
## Adding a _CONTRIBUTING_ file
36+
## Adding a `CONTRIBUTING.md` file
3237

3338
{% data reusables.repositories.navigate-to-repo %}
3439
{% data reusables.files.add-file %}

0 commit comments

Comments
 (0)