diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4286694bb2d1..e09961fbffa2 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,113 +2,86 @@ Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:. -**📖 For comprehensive contribution guidance, please visit our official documentation at [docs.github.com/en/contributing](https://docs.github.com/en/contributing). This is our canonical source for all contribution processes and policies.** - Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. -This guide provides repository-specific information to supplement the official contribution documentation. For detailed processes, policies, and best practices, always refer to [docs.github.com/en/contributing](https://docs.github.com/en/contributing). +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. -Use the table of contents icon Table of contents icon in the top corner of this document to get to a specific section of this guide quickly. +Use the table of contents icon Table of contents icon on the top left corner of this document to get to a specific section of this guide quickly. ## New contributor guide -**Start here:** Visit [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for complete contributor onboarding and guidelines. - -For repository-specific setup, read the [README](../README.md) file. The official docs site also provides these helpful resources: +To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions: - [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github) - [Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git) - [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) -## Contribution types and what we're looking for - -Content we accept: -* Technical and grammatical corrections -* Typo fixes -* Expanded explanations of existing products or features, when the expansion has a compelling reason -* New content filling important gaps in our documentation. For example, [this pull request](https://github.com/github/docs/pull/38048) added a useful section on security hardening for GitHub Actions. -Content we do not currently accept: -* Edits purely for tone, readability, or efficiency -* Topics that are too niche or a matter of personal preference -* Changes to the underlying site and workflows +## Getting started -These are general guidelines, but if you’re not sure what category your proposed change would fall under, feel free to open an issue to discuss it with us! +To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)." -## Getting started +Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:. -📚 **Primary resource:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) contains our complete contribution workflow and policies. +### Issues -For repository-specific information: -- See [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball: -- Check our [types of contributions](/contributing/types-of-contributions.md) we accept -- Review our markdown style guidelines in the `/contributing` directory +#### Create a new issue -### Writing style guidelines +If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose). -When contributing content, please follow these key principles from our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide): +#### Solve an issue -- **Clarity and simplicity**: The goal of our writing style is clarity and simplicity. -- **Meaning over grammar**: Grammatical correctness is important, but not as important as clarity and meaning. -- **Second person**: The docs use second-person ("you") to communicate directly with readers. -- **Inclusive language**: Use inclusive language by not assuming gender or ability level, and by avoiding slang and idioms. -- **Accessible technical language**: Jargon is sometimes necessary, but don't assume every reader has your technical expertise. -- **Active voice**: Use active voice wherever possible. Active voice means avoiding "be" verbs like "is" or "are" when you can, but also choosing more dynamic verbs to get your point across. "Press (a key)" is less dynamic than "tap (a key)," for example. -- **Clear terminology**: Avoid technical abbreviations like "repo" and "PR," and Latin abbreviations like "i.e." and "e.g." +Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. See "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)" for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. -For complete style guidance, see our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide). +### Make Changes -### Issues +#### Make changes in the UI -**For detailed issue guidelines, see [docs.github.com/en/contributing](https://docs.github.com/en/contributing).** +Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. -#### Repository-specific notes: -- Search [existing issues](https://github.com/github/docs/issues) before creating new ones -- Use our [label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference) to categorize appropriately -- Follow the issue templates provided in this repository + -### Make Changes +#### Make changes in a codespace -**Complete change guidelines are available at [docs.github.com/en/contributing](https://docs.github.com/en/contributing).** +For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)." -#### Repository-specific options: +#### Make changes locally -**Make changes in the UI:** Click **Make a contribution** at the bottom of any docs page for small changes like typos or broken links. +1. Fork the repository. +- Using GitHub Desktop: + - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. + - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - +- Using the command line: + - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. -**Make changes in a codespace:** See "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)" for documentation-specific setup. +2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md). -**Make changes locally:** -1. Fork the repository (see [official forking guide](https://docs.github.com/en/contributing)) -2. Install Node.js at the version specified in `.node-version` (see [development guide](../contributing/development.md)) -3. Create a working branch and start with your changes +3. Create a working branch and start with your changes! ### Commit your update -Follow the guidelines at [docs.github.com/en/contributing](https://docs.github.com/en/contributing) for commit best practices. - -Use our "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" before committing. +Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:. ### Pull Request -**Complete pull request (PR) guidelines:** [docs.github.com/en/contributing](https://docs.github.com/en/contributing) - -**Repository-specific notes:** -- Fill the "Ready for review" template -- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable -- Enable [maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) - -A Docs team member will review following our [standard review process](https://docs.github.com/en/contributing). +When you're finished with the changes, create a pull request, also known as a PR. +- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. +- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. +- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. +Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information. +- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. +- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. ### Your PR is merged! Congratulations :tada::tada: The GitHub team thanks you :sparkles:. -Once merged, your contributions will be visible on [GitHub docs](https://docs.github.com/en). +Once your PR is merged, your contributions will be publicly visible on the [GitHub docs](https://docs.github.com/en). -Continue contributing using our [types of contributions guide](/contributing/types-of-contributions.md) or explore more opportunities at [docs.github.com/en/contributing](https://docs.github.com/en/contributing). +Now that you are part of the GitHub docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md). ## Windows diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md index 9e93583985d4..43e40e2d3354 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/managing-policies-for-code-governance.md @@ -44,8 +44,6 @@ You can edit a ruleset to change parts of the ruleset, such as the name, bypass 1. In the left sidebar, in the "Policies" section, click **Code**, then click **Rulesets**. 1. To the right of the ruleset's name, select {% octicon "kebab-horizontal" aria-label="Open additional options" %}, then click **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete ruleset**. -{% ifversion repo-rules-history %} - ## Using ruleset history {% data reusables.repositories.ruleset-beta-note %} @@ -57,10 +55,6 @@ You can edit a ruleset to change parts of the ruleset, such as the name, bypass 1. To view the history of changes to the ruleset, select {% octicon "kebab-horizontal" aria-label="Open additional options" %} to the right of the ruleset's name, then click **{% octicon "history" aria-hidden="true" aria-label="history" %} History**. 1. To the right of the specific iteration, select {% octicon "kebab-horizontal" aria-label="Open additional options" %}, then click **Compare changes**, **Restore**, or **Download**. -{% endif %} - -{% ifversion repo-rules-management %} - ## Importing a ruleset You can import a ruleset from another repository, organization or enterprise using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories, organizations or enterprises. @@ -71,8 +65,6 @@ You can import a ruleset from another repository, organization or enterprise usi 1. Open the exported JSON file. 1. Review the imported ruleset and click **Create**. -{% endif %} - ## Viewing insights for rulesets You can view insights for rulesets to see how rulesets are affecting the repositories in your enterprise. {% data reusables.repositories.about-ruleset-insights %} diff --git a/content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md index 7e602ba34432..61171970ec08 100644 --- a/content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/creating-rulesets-for-repositories-in-your-organization.md @@ -34,7 +34,7 @@ Forks _do_ inherit push rulesets from their root repository. {% data reusables.r To import one of the prebuilt rulesets by {% data variables.product.prodname_dotcom %}, see [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes). {% ifversion repo-rules-management %} -{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).{% endif %} +{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history).{% endif %} ## Using `fnmatch` syntax diff --git a/content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md b/content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md index a8557de14ae0..b7a6ba12e45a 100644 --- a/content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization.md @@ -43,7 +43,7 @@ You can use the REST and GraphQL APIs to manage rulesets. For more information, {% data reusables.organizations.access-ruleset-settings %} {% data reusables.repositories.delete-ruleset-steps %} -{% ifversion repo-rules-history %} +{% ifversion repo-rules-management %} ## Using ruleset history @@ -56,11 +56,7 @@ You can use the REST and GraphQL APIs to manage rulesets. For more information, {% data reusables.organizations.access-ruleset-settings %} {% data reusables.repositories.ruleset-history %} -{% endif %} - -{% ifversion repo-rules-management %} - -## Importing a ruleset +### Importing a ruleset You can import a ruleset from another repository or organization using the exported JSON file from the previous section. This can be useful if you want to apply the same ruleset to multiple repositories or organizations. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md index 0b714079366d..963ebbc2b340 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository.md @@ -34,7 +34,7 @@ For customers on {% data variables.product.prodname_team %} and {% data variable To import one of the prebuilt rulesets by {% data variables.product.prodname_dotcom %}, see [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes). -{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).{% endif %} +{% data reusables.repositories.import-a-ruleset-conceptual %} For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#using-ruleset-history).{% endif %} ## Using `fnmatch` syntax diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md index 57f87eed0d8b..e84706b0b127 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md @@ -73,31 +73,31 @@ You can also view active ruselets: {% data reusables.repositories.repo-rulesets-settings %} {% data reusables.repositories.delete-ruleset-steps %} -{% ifversion repo-rules-history %} - -## Using ruleset history +{% ifversion repo-rules-management %} -{% data reusables.repositories.ruleset-beta-note %} +## Importing a ruleset -{% data reusables.repositories.ruleset-history-conceptual %} +{% data reusables.repositories.import-a-ruleset-conceptual %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repo-rulesets-settings %} -{% data reusables.repositories.ruleset-history %} +{% data reusables.repositories.import-a-ruleset %} {% endif %} -{% ifversion repo-rules-management %} +{% ifversion repo-rules-enterprise %} -## Importing a ruleset +## Using ruleset history -{% data reusables.repositories.import-a-ruleset-conceptual %} +{% data reusables.repositories.ruleset-beta-note %} + +{% data reusables.repositories.ruleset-history-conceptual %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repo-rulesets-settings %} -{% data reusables.repositories.import-a-ruleset %} +{% data reusables.repositories.ruleset-history %} ## Viewing insights for rulesets diff --git a/data/features/repo-rules-history.yml b/data/features/repo-rules-history.yml deleted file mode 100644 index 498d24c9a6d8..000000000000 --- a/data/features/repo-rules-history.yml +++ /dev/null @@ -1,5 +0,0 @@ -# Reference: #20126 -# Ruleset history -versions: - ghec: '*' - ghes: '>=3.19' diff --git a/data/features/repo-rules-management.yml b/data/features/repo-rules-management.yml index e5a42556b9f8..9832e942859f 100644 --- a/data/features/repo-rules-management.yml +++ b/data/features/repo-rules-management.yml @@ -1,5 +1,5 @@ # Reference: #11915 and #16558 -# Ruleset management (import/export) public preview and GA +# Ruleset management public preview and GA versions: fpt: '*' ghec: '*' diff --git a/data/release-notes/enterprise-server/3-17/0-rc1.yml b/data/release-notes/enterprise-server/3-17/0-rc1.yml index 973f024ce656..be14c3a7e3e9 100644 --- a/data/release-notes/enterprise-server/3-17/0-rc1.yml +++ b/data/release-notes/enterprise-server/3-17/0-rc1.yml @@ -118,6 +118,9 @@ sections: # https://github.com/github/releases/issues/4042 - | Push rulesets are generally available. Users can block pushes to private and internal repositories, and their forks, based on file type, path, or size. Unlike pre-receive hooks, push rules are built-in, configurable via the UI or API, and support audit logs, evaluate mode, and bypass lists. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#push-rulesets). + # https://github.com/github/releases/issues/5128 + - | + Enterprise administrators can manage rules more efficiently with the general availability of ruleset history, import, and export. Ruleset history allows tracking and rolling back changes, while import and export simplify sharing and reusing rulesets, including GitHub's ruleset-recipes. See [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes). # https://github.com/github/releases/issues/5129 - | Repository administrators can easily convert a fork into a standalone repository by leaving the fork network, which stops automatic syncing with the upstream repository. This is useful for taking a project in a new direction or maintaining separate versions. diff --git a/data/release-notes/enterprise-server/3-17/0.yml b/data/release-notes/enterprise-server/3-17/0.yml index 0ba97fee3ba5..9303fde381c8 100644 --- a/data/release-notes/enterprise-server/3-17/0.yml +++ b/data/release-notes/enterprise-server/3-17/0.yml @@ -122,6 +122,9 @@ sections: # https://github.com/github/releases/issues/4042 - | Push rulesets are generally available. Users can block pushes to private and internal repositories, and their forks, based on file type, path, or size. Unlike pre-receive hooks, push rules are built-in, configurable via the UI or API, and support audit logs, evaluate mode, and bypass lists. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets#push-rulesets). + # https://github.com/github/releases/issues/5128 + - | + Enterprise administrators can manage rules more efficiently with the general availability of ruleset history, import, and export. Ruleset history allows tracking and rolling back changes, while import and export simplify sharing and reusing rulesets, including GitHub's ruleset-recipes. See [`github/ruleset-recipes`](https://github.com/github/ruleset-recipes). # https://github.com/github/releases/issues/5129 - | Repository administrators can easily convert a fork into a standalone repository by leaving the fork network, which stops automatic syncing with the upstream repository. This is useful for taking a project in a new direction or maintaining separate versions.