Change file

CONTRIBUTING.md

@@ -1,6 +1,7 @@
-# Contributing to `toolchain` GitHub action
+# Contributing to `toolchain` GitHub Action
 
-The following is a set of guidelines for contributing to `actions-rs` GitHub Actions.
+The following is a set of guidelines for contributing to the `toolchain` GitHub
+Action.
 
 ## Reporting bugs
 
@@ -21,22 +22,27 @@ Explain the problem and include additional details to help maintainers reproduce
 2. Describe the exact steps which reproduce the problem in as many details as possible.
 3. Provide specific examples to demonstrate the steps.
    Include links to the workflow files (pointing to the specific commit, and not to the `main` branch) and
-   attach step logs to the issue (consider enabling [debug logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md) first)
+   attach step logs to the issue (consider enabling
+   [debug logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md)
+   first).
 4. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
-5. Explain which behavior you expected to see instead and why.
+5. Explain which behavior you expected to see instead **and why**.
 
 ## Feature requests
 
 **New ideas are welcomed!**
 
-Feature requests are also tracked as a GitHub issues in the corresponding Action repositories.
+Feature requests are also tracked as a GitHub issues in the corresponding
+Action repositories.
 
 Explain the idea and include as many additional details as possible:
 
-1. Use a clear and descriptive title for the issue
-2. Describe your motivation and how Rust community could benefit from this change
-3. Provide workflow step examples, if applicable
-4. Include links to the related tools, alternative implementations or any other information sources
+1. Use a clear and descriptive title for the issue.
+2. Describe your motivation and how Rust community could benefit from this
+   change.
+3. Provide workflow step examples, if applicable.
+4. Include links to the related tools, alternative implementations or any other
+   information sources.
 
 ### Backwards compatibility
 
@@ -46,20 +52,26 @@ till there will be enough changes to make a new major release.
 
 ## Pull Requests
 
-If your change introduces any new functionality or breaks the backwards compatibility in any matter -
-do not rush to create a Pull Request at all.
+### Breaking changes
 
-Do not waste your time on that, check [Backwards compatibility](#backwards-compatibility)
-section first for motivation, and create an issue first,
-explain why you want to make this change and let the discussion happen.
+If your change introduces any new functionality or breaks the backwards
+compatibility in any matter - **do not rush to create a Pull Request at all**.
+
+Do not waste your time on that, check
+[Backwards compatibility](#backwards-compatibility) section first for
+motivation, and create an issue first, explain why you want to make this change
+and let the discussion happen.
+
+### Open a Pull Request
 
 The Code you are contributing should pass the following checks:
 
 1. Should change only one specific thing
 2. Not raising any compiler errors or warnings
+    - **do not use lint annotations to mask specific error**
 3. Conforms to formatting rules (use `npm run format` command)
 4. Not raising any lint warnings (use `npm run lint` command)
-5. Should pass the CI tests
+5. All tests should pass (use `npm run test` command)
 
 Now create a GitHub Pull Request with a patch: