|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 30 KiB |
BIN
assets/images/help/repository/tag-protection-rule.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
@@ -17,23 +17,23 @@ The community profile checklist checks to see if a project includes recommended
|
||||
|
||||
## Using the community profile checklist as a repository maintainer
|
||||
|
||||
As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides.
|
||||
As a repository maintainer, you can use the community standards checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides.
|
||||
|
||||
If a project doesn't have a recommended file, you can click **Add** to draft and submit a file.
|
||||
If a project doesn't have one of the recommended files, you can click the associated **Add** button to draft and submit a file.
|
||||
|
||||
{% data reusables.repositories.valid-community-issues %} For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
|
||||

|
||||

|
||||
|
||||
{% data reusables.repositories.security-guidelines %}
|
||||
|
||||
{% data reusables.repositories.valid-community-issues %} For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
|
||||
## Using the community profile checklist as a community member or collaborator
|
||||
|
||||
As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "[How to contribute](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)" in the Open Source Guides.
|
||||
|
||||
If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval.
|
||||
|
||||

|
||||

|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -15,8 +15,7 @@ shortTitle: Access community profiles
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.accessing-repository-graphs %}
|
||||
3. In the left sidebar, click **Community**.
|
||||

|
||||
3. In the left sidebar, click **Community Standards** to show the checklist for the community profile of the repository.
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -25,16 +25,15 @@ shortTitle: Configure
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
3. In the "Features" section, under "Issues," click **Set up templates**.
|
||||

|
||||
4. Use the Add template drop-down menu, and click on the type of template you'd like to create.
|
||||

|
||||
3. In the "Features" section, under "Issues," click **Set up templates**. You may need to enable "Issues" and refresh the page before you can see the button.
|
||||
4. Use the Add template dropdown menu, and click on the type of template you'd like to create.
|
||||
|
||||

|
||||
5. To preview or edit the template before committing it to the repository, click **Preview and edit**.
|
||||

|
||||
6. To edit the template, click {% octicon "pencil" aria-label="The edit icon" %}, and type in the fields to edit their contents.
|
||||

|
||||
7. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with `title`, `labels`, or `assignees` in a YAML frontmatter format.
|
||||

|
||||
7. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to issues raised from the template, use the fields under "Optional additional information." You can also add these details in the issue template with `title`, `labels`, or `assignees` in a YAML frontmatter format.
|
||||
8. When you're finished editing and previewing your template, click **Propose changes** in the upper right corner of the page.
|
||||

|
||||
9. Enter a commit message describing your changes.
|
||||
|
||||
@@ -46,9 +46,13 @@ When creating a topic:
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}.
|
||||

|
||||
3. Under "Topics", type the topic you want to add to your repository, then type a space.
|
||||

|
||||
4. After you've finished adding topics, click **Save changes**.
|
||||

|
||||
2. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}.
|
||||
|
||||

|
||||
|
||||
3. Under "Topics", start to type the topic you want to add to your repository to display a dropdown menu of any matching topics. Click the topic you want to add or continue typing to create a new topic.
|
||||
|
||||

|
||||
|
||||
4. Optional, if there are "Suggested" topics displayed under the "Topics" field, click {% octicon "plus" aria-label="Add this topic" %} to add or {% octicon "dash" aria-label="Decline this topic" %} to decline the suggested topic.
|
||||
5. After you've finished adding topics, click **Save changes**.
|
||||
@@ -35,20 +35,21 @@ This procedure demonstrates how to configure autolinks to reference external res
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %}
|
||||
1. In the "Integrations" section of the sidebar, click **{% octicon "cross-reference" aria-label="The cross-reference icon" %} Autolink references**.
|
||||
1. In the "Integrations" section of the sidebar, click **{% octicon "cross-reference" aria-label="" %} Autolink references**.
|
||||
{% else %}
|
||||
1. In the left sidebar, click **Autolink references**.
|
||||

|
||||
{% endif %}
|
||||
1. Click **Add autolink reference**.
|
||||

|
||||
1. At the top right of the page, click **Add autolink reference**.
|
||||
|
||||

|
||||
{% ifversion autolink-reference-alphanumeric %}
|
||||
1. Select the format of the reference identifier used in the external resource, either alphanumeric or numeric.
|
||||

|
||||
1. Select the format of the reference identifier used in the external resource, either **Alphanumeric** or **Numeric**.
|
||||
{% endif %}
|
||||
1. Under "Reference prefix", type a short, meaningful prefix you want collaborators to use to generate autolinks for the external resource.
|
||||
{% ifversion autolink-reference-alphanumeric %}{% else %}{% endif %}
|
||||
1. Under "Target URL", type the link to the external system you want to link to. Use the `<num>` variable as a placeholder for the reference identifier.
|
||||
{% ifversion autolink-reference-alphanumeric %}{% else %}{% endif %}
|
||||
1. Click **Add autolink reference**.
|
||||
{% ifversion autolink-reference-alphanumeric %}{% else %}{% endif %}
|
||||
1. Under "Reference prefix", type a short, meaningful prefix. Collaborators will use this text to generate autolinks for the external resource.
|
||||
1. Under "Target URL", type the format of the link to the external system you want to create. Use the `<num>` variable as a placeholder for the reference identifier.
|
||||
1. Review the preview and verify that the autolink and external reference are both correct, then click **Add autolink reference** to define the link.
|
||||
|
||||
For example, you might enter the following.
|
||||
- Reference prefix: `JIRA-`
|
||||
- Target URL: `https://jira.example.com/issue?query=<num>`
|
||||
- Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123`
|
||||
@@ -25,8 +25,6 @@ Additionally, you can create custom repository roles to allow other groups of us
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. In the "Code and automation" section of the sidebar, click **{% octicon "tag" aria-label="The tag icon" %} Tags**.
|
||||
1. Click **New rule**.
|
||||

|
||||
1. Under "Tag name pattern", type the pattern of the tags you want to protect. In this example, typing "\*" protects all tags.
|
||||

|
||||

|
||||
1. Click **Add rule**.
|
||||

|
||||
|
||||
@@ -1 +1 @@
|
||||
1. In the "Access" section of the sidebar, click **{% octicon "people" aria-label="The people icon" %} Collaborators & teams**.
|
||||
1. In the "Access" section of the sidebar, click **{% octicon "people" aria-label="" %} Collaborators & teams**.
|
||||
|
||||
@@ -1 +1 @@
|
||||
To be included in the community profile checklist, issue templates must be located in the `.github/ISSUE_TEMPLATE` folder and contain valid `name:` and `about:` keys in the YAML frontmatter (for issue templates defined in `.md` files) or valid `name:` and `description:` keys (for issue forms defined in `.yml` files).
|
||||
To be displayed with a {% octicon "check" aria-label="Added" %} checkmark in the community profile checklist, issue templates must be located in the `.github/ISSUE_TEMPLATE` folder and contain valid `name:` and `about:` keys in the YAML frontmatter (for issue templates defined in `.md` files) or valid `name:` and `description:` keys (for issue forms defined in `.yml` files).
|
||||
|
||||