From 63a003d198e2a66dd213774da547aeee482ef904 Mon Sep 17 00:00:00 2001 From: MURALI Date: Fri, 7 May 2021 16:09:11 +0530 Subject: [PATCH 1/4] Issue 1981: Setting guidelines for contributors --- .../setting-guidelines-for-repository-contributors.md | 7 ++++--- .../github/managing-your-work-on-github/managing-labels.md | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 94a56b1853..ab2cbc2f94 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -12,8 +12,8 @@ redirect_from: topics: - Community --- - -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. +### About contributing guidelines +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. Also link to the contributing guidelines is shown on the repository's contribute page. ![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) @@ -39,10 +39,11 @@ You can create default contribution guidelines for your organization{% if curren {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive, and can have an extension such as *.md* or *.txt*. +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive, and files are rendered using rich text format if it's extension is in supported format. For more information, see "[Rendering differences in prose documents](/github/managing-files-in-a-repository/rendering-differences-in-prose-documents)." ![New file name](/assets/images/help/repository/new-file-name.png) - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen in order from `.github` directory, the repository's root directory and then the `docs` directory. 4. In the new file, add contribution guidelines. These could include: - Steps for creating good issues or pull requests. - Links to external documentation, mailing lists, or a code of conduct. diff --git a/content/github/managing-your-work-on-github/managing-labels.md b/content/github/managing-your-work-on-github/managing-labels.md index f448e5f332..9a5bd87243 100644 --- a/content/github/managing-your-work-on-github/managing-labels.md +++ b/content/github/managing-your-work-on-github/managing-labels.md @@ -49,6 +49,8 @@ Label | Description Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. +Issues with the `good first issue` label are used to populate the repository's contribute page. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)." {% endif %} From 02ff480aeacf936546db0d415b4e4ae20da4d495 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 13 May 2021 16:32:04 -0400 Subject: [PATCH 2/4] Apply suggestions from code review --- .../setting-guidelines-for-repository-contributors.md | 6 +++--- .../github/managing-your-work-on-github/managing-labels.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index ab2cbc2f94..a9d9b9d344 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -13,7 +13,7 @@ topics: - Community --- ### About contributing guidelines -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. Also link to the contributing guidelines is shown on the repository's contribute page. +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. 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). ![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) @@ -39,11 +39,11 @@ You can create default contribution guidelines for your organization{% if curren {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive, and files are rendered using rich text format if it's extension is in supported format. For more information, see "[Rendering differences in prose documents](/github/managing-files-in-a-repository/rendering-differences-in-prose-documents)." +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Rendering differences in prose documents](/github/managing-files-in-a-repository/rendering-differences-in-prose-documents)." ![New file name](/assets/images/help/repository/new-file-name.png) - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. - - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen in order from `.github` directory, the repository's root directory and then the `docs` directory. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. 4. In the new file, add contribution guidelines. These could include: - Steps for creating good issues or pull requests. - Links to external documentation, mailing lists, or a code of conduct. diff --git a/content/github/managing-your-work-on-github/managing-labels.md b/content/github/managing-your-work-on-github/managing-labels.md index 9a5bd87243..c182e97d3d 100644 --- a/content/github/managing-your-work-on-github/managing-labels.md +++ b/content/github/managing-your-work-on-github/managing-labels.md @@ -49,7 +49,7 @@ Label | Description Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. -Issues with the `good first issue` label are used to populate the repository's contribute page. +Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute) {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)." From e9a21f1bb8cba11666cb9095f19e11745b152f2c Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 13 May 2021 16:43:00 -0400 Subject: [PATCH 3/4] Added a missing period --- content/github/managing-your-work-on-github/managing-labels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/github/managing-your-work-on-github/managing-labels.md b/content/github/managing-your-work-on-github/managing-labels.md index c182e97d3d..37985e5905 100644 --- a/content/github/managing-your-work-on-github/managing-labels.md +++ b/content/github/managing-your-work-on-github/managing-labels.md @@ -49,7 +49,7 @@ Label | Description Default labels are included in every new repository when the repository is created, but you can edit or delete the labels later. -Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute) +Issues with the `good first issue` label are used to populate the repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} Organization owners can customize the default labels for repositories in their organization. For more information, see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)." From f3b6db3137a89a5a47aa79f932dde3c695eb1874 Mon Sep 17 00:00:00 2001 From: James Martin Date: Fri, 14 May 2021 06:22:53 +0930 Subject: [PATCH 4/4] Consistent use of "private" vs "internal" terms for GitHub Apps (#6030) --- .../apps/making-a-github-app-public-or-private.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/developers/apps/making-a-github-app-public-or-private.md b/content/developers/apps/making-a-github-app-public-or-private.md index bcc4d52b22..cff121bf5e 100644 --- a/content/developers/apps/making-a-github-app-public-or-private.md +++ b/content/developers/apps/making-a-github-app-public-or-private.md @@ -23,7 +23,7 @@ Public installation flows have a landing page to enable other people besides the ### Private installation flow -Private installation flows allow only the owner of a GitHub App to install it. Limited information about the GitHub App will still exist on a public page, but the **Install** button will only be available to organization administrators or the user account if the GitHub App is owned by an individual account. Private, or internal, GitHub Apps can only be installed on the user or organization account of the owner. +Private installation flows allow only the owner of a GitHub App to install it. Limited information about the GitHub App will still exist on a public page, but the **Install** button will only be available to organization administrators or the user account if the GitHub App is owned by an individual account. Private{% if currentVersion ver_lt "enterprise-server@3.2" or currentVersion == "github-ae@latest" %}, or internal,{% endif %} GitHub Apps can only be installed on the user or organization account of the owner. ### Changing who can install your GitHub App @@ -35,7 +35,7 @@ To change who can install the GitHub App: 3. Select the GitHub App whose installation option you want to change. ![App selection](/assets/images/github-apps/github_apps_select-app.png) {% data reusables.user-settings.github_apps_advanced %} -5. Depending on the installation option of your GitHub App, click either **Make public** or **Make internal**. +5. Depending on the installation option of your GitHub App, click either **Make public** or **Make {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}private{% else %}internal{% endif %}**. ![Button to change the installation option of your GitHub App](/assets/images/github-apps/github_apps_make_public.png) -6. Depending on the installation option of your GitHub App, click either **Yes, make this GitHub App public** or **Yes, make this GitHub App internal**. +6. Depending on the installation option of your GitHub App, click either **Yes, make this GitHub App public** or **Yes, make this GitHub App {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}private{% else %}internal{% endif %}**. ![Button to confirm the change of your installation option](/assets/images/github-apps/github_apps_confirm_installation_option.png)