From 049de846499e506d924b5cde783f49b5d9a47633 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii Date: Thu, 14 Jul 2022 14:33:15 +0200 Subject: [PATCH 01/21] docs(contributors guide): Updated contributors guide --- docs/contributors.md | 100 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 91 insertions(+), 9 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 3123bf43e..a8058ff16 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -1,17 +1,99 @@ # Contributors +Thank you for contributing! +We have prepared a short guide so that the process of making your contribution is as simple and clear as possible. Please check it out before you contribute! +## How can I contribute... + * [Contribute Documentation:green_book:](#contribute-documentation) + * [Contribute Code :computer:](#contribute-code) + * [Provide Support on Issues:pencil:](#provide-support-on-issues) + * [Review Pull Requests:mag:](#review-pull-requests) + + ## Contribute documentation +Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need in order to be able to use this project or contribute to it. So thank you in advance. +Documentation contributions of any size are welcome! Feel free to contribute even if you're just rewording a sentence to be more clear, or fixing a spelling mistake! -# Checkin +**How to contribute:** +Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. -- Do checkin source (src) -- Do checkin build output (lib) -- Do checkin runtime node_modules -- Do not checkin + - Please check that no one else has already created a pull request with these changes. + - Fork this repository + - Clone the repository to your local machine + - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature branch": + - Update your local git fork to the tip (main branch, usually) + - Create the feature branch + - Edit or add any relevant documentation + - Make sure your changes are formatted correctly and consistently with the rest of the documentation + - Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything + - Commit changes locally + - Push them to your GitHub fork + - Go to https://github.com/actions/setup-go/pulls and open a new pull request with your changes. + - If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. + - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated + +**Once you've filed the pull request:** + - One or more maintainers will use GitHub's review feature to review your pull request + - If the maintainer asks for any changes, edit your changes, push, and ask for another review + - If the maintainer decides to pass on your pull request, they will thank you for the + contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: + - If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release + +## Contribute code -# Adding a dev dependency +We like code commits a lot! They're super handy, and they keep the project going and doing the work it needs to do to be useful to others. -Remember to update .gitignore. +Code contributions of just about any size are acceptable! -# Updating toolkit dependency +The main difference between code contributions and documentation contributions is that contributing code requires inclusion of relevant tests for the code being added or changed. Contributions without accompanying tests will be held off until a test is added, unless the maintainers consider the specific tests to be either impossible, or way too much of a burden for such a contribution. -Until released publically, update tgz packages in toolkit \ No newline at end of file +**How to contribute:** +Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. + +- Please check that no one else has already created a pull request with these changes +- Fork this repository +- Clone the repository to your local machine +- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature branch": + - Update your local git fork to the tip (main branch, usually) + - Create the feature branch + - Add changes and relevant tests + - **Run `pre-checkin` script to format, build and test changes** + - Make sure your changes are well formatted and tests pass + - Commit changes locally + - Push them to your GitHub fork + - Go to https://github.com/actions/setup-go/pulls and open a new pull request with your changes. + - If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. + - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated + +**Once you've filed the pull request:** + - CI will start automatically with some checks. Wait for the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code + - One or more maintainers will use GitHub's review feature to review your pull request + - If the maintainer asks for any changes, edit your changes, push, and ask for another review + - If the maintainer decides to pass on your pull request, they will thank you for the + contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: + - If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release + + ## Provide support on issues + +Helping out other users with their questions is a really awesome way of contributing to any community. It's not uncommon for most of the issues on an open source projects being support-related questions by users trying to understand something they ran into, or find their way around a known bug. + +**In order to help other folks out with their questions:** + + - Go to the [issue tracker](https://github.com/actions/setup-go/issues) + - Read through the list until you find something that you're familiar enough with to give an answer to + - Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on + - Once the discussion wraps up and things are clarified, ask the original issue filer (or a maintainer) to close it for you + +*Some notes on picking up support issues:* + + - Avoid responding to issues you don't know you can answer accurately + - As much as possible, try to refer to past issues with accepted answers. Link to them from your replies with the #123 format + - Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* + +## Review pull requests + +Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) -- always respond with respect, be understanding, but don't feel like you need to sacrifice your standards for their sake, either. + +**How to review:** + - Go to the [pull requests](https://github.com/actions/setup-go/pulls) + - Make sure you're familiar with the code or documentation being updated, unless it's a minor change (spellchecking, minor formatting, etc.) +- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. (Note: You may ask for minor changes ("nitpicks"), but consider whether they are really blockers to merging or not) +- Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file From afb42575fb7cd40f618f34aad9acee0612f5144a Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii Date: Mon, 18 Jul 2022 09:14:48 +0200 Subject: [PATCH 02/21] rephrased doc --- docs/contributors.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index a8058ff16..ca7b2c64d 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -18,7 +18,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Please check that no one else has already created a pull request with these changes. - Fork this repository - Clone the repository to your local machine - - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature branch": + - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Use a "feature branch" to run your workflows: - Update your local git fork to the tip (main branch, usually) - Create the feature branch - Edit or add any relevant documentation @@ -56,7 +56,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Create the feature branch - Add changes and relevant tests - **Run `pre-checkin` script to format, build and test changes** - - Make sure your changes are well formatted and tests pass + - Make sure your changes are well formatted and that all tests are passing - Commit changes locally - Push them to your GitHub fork - Go to https://github.com/actions/setup-go/pulls and open a new pull request with your changes. @@ -85,7 +85,7 @@ Helping out other users with their questions is a really awesome way of contribu *Some notes on picking up support issues:* - Avoid responding to issues you don't know you can answer accurately - - As much as possible, try to refer to past issues with accepted answers. Link to them from your replies with the #123 format + - Try to refer to past issues with accepted answers as much as possible. Link to them from your replies with the #123 format - Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* ## Review pull requests From 233e44dd5ffdd0ce42c9c1a93d8bf51faa927d97 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii Date: Fri, 22 Jul 2022 09:10:19 +0200 Subject: [PATCH 03/21] update docs --- docs/contributors.md | 144 ++++++++++++++++++++++++------------------- 1 file changed, 79 insertions(+), 65 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index ca7b2c64d..8eafb5cec 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -1,42 +1,44 @@ # Contributors -Thank you for contributing! + +Thank you for contributing! + We have prepared a short guide so that the process of making your contribution is as simple and clear as possible. Please check it out before you contribute! -## How can I contribute... - * [Contribute Documentation:green_book:](#contribute-documentation) - * [Contribute Code :computer:](#contribute-code) - * [Provide Support on Issues:pencil:](#provide-support-on-issues) - * [Review Pull Requests:mag:](#review-pull-requests) - - ## Contribute documentation -Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need in order to be able to use this project or contribute to it. So thank you in advance. + +## How can I contribute... + +* [Contribute Documentation:green_book:](#contribute-documentation) + +* [Contribute Code :computer:](#contribute-code) + +* [Provide Support on Issues:pencil:](#provide-support-on-issues) + +* [Review Pull Requests:mag:](#review-pull-requests) + +## Contribute documentation + +Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need in order to be able to use this project or contribute to it. So thank you in advance. Documentation contributions of any size are welcome! Feel free to contribute even if you're just rewording a sentence to be more clear, or fixing a spelling mistake! -**How to contribute:** +**How to contribute:** + Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. - - Please check that no one else has already created a pull request with these changes. - - Fork this repository - - Clone the repository to your local machine - - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Use a "feature branch" to run your workflows: - - Update your local git fork to the tip (main branch, usually) - - Create the feature branch - - Edit or add any relevant documentation - - Make sure your changes are formatted correctly and consistently with the rest of the documentation - - Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything - - Commit changes locally - - Push them to your GitHub fork - - Go to https://github.com/actions/setup-go/pulls and open a new pull request with your changes. - - If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. - - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated - +- Please check that no one else has already created a pull request with these changes +- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. +- Make sure your changes are formatted correctly and consistently with the rest of the documentation +- Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything +- If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. +- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated + **Once you've filed the pull request:** - - One or more maintainers will use GitHub's review feature to review your pull request - - If the maintainer asks for any changes, edit your changes, push, and ask for another review - - If the maintainer decides to pass on your pull request, they will thank you for the - contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: - - If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release - + +- One or more maintainers will use GitHub's review feature to review your pull request +- If the maintainer asks for any changes, edit your changes, push, and ask for another review +- If the maintainer decides to pass on your pull request, they will thank you for the +contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: +- If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release + ## Contribute code We like code commits a lot! They're super handy, and they keep the project going and doing the work it needs to do to be useful to others. @@ -45,55 +47,67 @@ Code contributions of just about any size are acceptable! The main difference between code contributions and documentation contributions is that contributing code requires inclusion of relevant tests for the code being added or changed. Contributions without accompanying tests will be held off until a test is added, unless the maintainers consider the specific tests to be either impossible, or way too much of a burden for such a contribution. -**How to contribute:** +**How to contribute:** + Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. - Please check that no one else has already created a pull request with these changes -- Fork this repository -- Clone the repository to your local machine -- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature branch": - - Update your local git fork to the tip (main branch, usually) - - Create the feature branch - - Add changes and relevant tests - - **Run `pre-checkin` script to format, build and test changes** - - Make sure your changes are well formatted and that all tests are passing - - Commit changes locally - - Push them to your GitHub fork - - Go to https://github.com/actions/setup-go/pulls and open a new pull request with your changes. - - If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. - - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated +- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request +- **Run `pre-checkin` script to format, build and test changes** +- Make sure your changes are well formatted and that all tests are passing +- If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. +- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated + +**Learn more about how to work with the repository:** + +- To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder +- To comply with the code style, **you need to run the `format` script** +- To compile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build +- You can also start formatting, building code, and testing with a single `pre-checkin` command + +**Learn more about how to implement tests:** + +Adding or changing tests is an integral part of making a change to the code. The tests are located in the `__tests__` folder and cover most of the functionality of the repository. + +- The contributor can add various types of tests (like unit tests or end-to-end tests), which, in his opinion, will be necessary and sufficient for testing new or changed functionality +- Tests should cover a successful execution, as well as some edge cases and possible errors +- As already mentioned, pull requests without tests will be considered more carefully by maintainers. If you are sure that in this situation the tests are not needed or cannot be implemented with a commensurate effort - please add this clarification message to your pull request **Once you've filed the pull request:** - - CI will start automatically with some checks. Wait for the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code - - One or more maintainers will use GitHub's review feature to review your pull request - - If the maintainer asks for any changes, edit your changes, push, and ask for another review - - If the maintainer decides to pass on your pull request, they will thank you for the - contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: - - If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release - - ## Provide support on issues + +- CI will start automatically with some checks. Wait for the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code +- One or more maintainers will use GitHub's review feature to review your pull request +- If the maintainer asks for any changes, edit your changes, push, and ask for another review +- If the maintainer decides to pass on your pull request, they will thank you for the +contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: +- If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release + +## Provide support on issues Helping out other users with their questions is a really awesome way of contributing to any community. It's not uncommon for most of the issues on an open source projects being support-related questions by users trying to understand something they ran into, or find their way around a known bug. **In order to help other folks out with their questions:** - - Go to the [issue tracker](https://github.com/actions/setup-go/issues) - - Read through the list until you find something that you're familiar enough with to give an answer to - - Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on - - Once the discussion wraps up and things are clarified, ask the original issue filer (or a maintainer) to close it for you - +- Go to the [issue tracker](https://github.com/actions/setup-go/issues) +- Read through the list until you find something that you're familiar enough with to give an answer to +- Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on +- Once the discussion wraps up and things are clarified, ask the original issue filer (or a maintainer) to close it for you + *Some notes on picking up support issues:* - - Avoid responding to issues you don't know you can answer accurately - - Try to refer to past issues with accepted answers as much as possible. Link to them from your replies with the #123 format - - Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* +- Avoid responding to issues you don't know you can answer accurately +- Try to refer to past issues with accepted answers as much as possible. Link to them from your replies with the #123 format +- Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* + ## Review pull requests + -Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) -- always respond with respect, be understanding, but don't feel like you need to sacrifice your standards for their sake, either. - +Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) -- always respond with respect, be understanding, but don't feel like you need to sacrifice your standards for their sake, either. + **How to review:** - - Go to the [pull requests](https://github.com/actions/setup-go/pulls) - - Make sure you're familiar with the code or documentation being updated, unless it's a minor change (spellchecking, minor formatting, etc.) + +- Go to the [pull requests](https://github.com/actions/setup-go/pulls) +- Make sure you're familiar with the code or documentation being updated, unless it's a minor change (spellchecking, minor formatting, etc.) - Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. (Note: You may ask for minor changes ("nitpicks"), but consider whether they are really blockers to merging or not) - Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file From 864dd7706466cf30a8c65da6dcab1e0ec97ddcd9 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii Date: Mon, 25 Jul 2022 10:11:43 +0200 Subject: [PATCH 04/21] fix gramma --- docs/contributors.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 8eafb5cec..3a56dc574 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -16,13 +16,13 @@ We have prepared a short guide so that the process of making your contribution i ## Contribute documentation -Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need in order to be able to use this project or contribute to it. So thank you in advance. +Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need to be able to use this project or contribute to it. So thank you in advance. Documentation contributions of any size are welcome! Feel free to contribute even if you're just rewording a sentence to be more clear, or fixing a spelling mistake! **How to contribute:** -Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. +Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes. - Please check that no one else has already created a pull request with these changes - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. @@ -45,11 +45,11 @@ We like code commits a lot! They're super handy, and they keep the project going Code contributions of just about any size are acceptable! -The main difference between code contributions and documentation contributions is that contributing code requires inclusion of relevant tests for the code being added or changed. Contributions without accompanying tests will be held off until a test is added, unless the maintainers consider the specific tests to be either impossible, or way too much of a burden for such a contribution. +The main difference between code contributions and documentation contributions is that contributing code requires the inclusion of relevant tests for the code being added or changed. Contributions without accompanying tests will be held off until a test is added unless the maintainers consider the specific tests to be either impossible or way too much of a burden for such a contribution. **How to contribute:** -Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes. +Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes. - Please check that no one else has already created a pull request with these changes - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request @@ -75,7 +75,7 @@ Adding or changing tests is an integral part of making a change to the code. The **Once you've filed the pull request:** -- CI will start automatically with some checks. Wait for the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code +- CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code - One or more maintainers will use GitHub's review feature to review your pull request - If the maintainer asks for any changes, edit your changes, push, and ask for another review - If the maintainer decides to pass on your pull request, they will thank you for the @@ -84,12 +84,12 @@ contribution and explain why they won't be accepting the changes. That's ok! We ## Provide support on issues -Helping out other users with their questions is a really awesome way of contributing to any community. It's not uncommon for most of the issues on an open source projects being support-related questions by users trying to understand something they ran into, or find their way around a known bug. +Helping out other users with their questions is an awesome way of contributing to any community. It's not uncommon for most of the issues on open source projects to be support-related questions by users trying to understand something they ran into or find their way around a known bug. -**In order to help other folks out with their questions:** +**To help other folks out with their questions:** - Go to the [issue tracker](https://github.com/actions/setup-go/issues) -- Read through the list until you find something that you're familiar enough with to give an answer to +- Read through the list until you find something that you're familiar enough with to answer to - Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on - Once the discussion wraps up and things are clarified, ask the original issue filer (or a maintainer) to close it for you @@ -108,6 +108,6 @@ Another great way to contribute is pull request reviews. Please, be extra kind: **How to review:** - Go to the [pull requests](https://github.com/actions/setup-go/pulls) -- Make sure you're familiar with the code or documentation being updated, unless it's a minor change (spellchecking, minor formatting, etc.) -- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. (Note: You may ask for minor changes ("nitpicks"), but consider whether they are really blockers to merging or not) +- Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.) +- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. (Note: You may ask for minor changes ("nitpicks"), but consider whether they are real blockers to merging or not) - Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file From c35e03b51290dec79e5650e22c02669641a781b5 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:18:48 +0200 Subject: [PATCH 05/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 3a56dc574..7cd0fba79 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -16,7 +16,7 @@ We have prepared a short guide so that the process of making your contribution i ## Contribute documentation -Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies. And it's how we tell others everything they need to be able to use this project or contribute to it. So thank you in advance. +Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies and how we tell others everything they need to be able to use this project or contribute to it. Documentation contributions of any size are welcome! Feel free to contribute even if you're just rewording a sentence to be more clear, or fixing a spelling mistake! From a7338d1fc9a4bdd8772f836133f6351179013857 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:19:16 +0200 Subject: [PATCH 06/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 7cd0fba79..c3b8e6e30 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -25,7 +25,7 @@ Documentation contributions of any size are welcome! Feel free to contribute eve Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes. - Please check that no one else has already created a pull request with these changes -- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. +- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request - Make sure your changes are formatted correctly and consistently with the rest of the documentation - Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything - If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. From 0b05709db80ce7337cde1c08c97009c8ad88b0ba Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:20:09 +0200 Subject: [PATCH 07/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index c3b8e6e30..a68926e3b 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -28,7 +28,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request - Make sure your changes are formatted correctly and consistently with the rest of the documentation - Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything -- If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. +- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated **Once you've filed the pull request:** From 985d5990dd77133a1d5eef9b36640088deed00d7 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:20:22 +0200 Subject: [PATCH 08/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index a68926e3b..0d96f0850 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -33,7 +33,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. **Once you've filed the pull request:** -- One or more maintainers will use GitHub's review feature to review your pull request +- Maintainers will review your pull request - If the maintainer asks for any changes, edit your changes, push, and ask for another review - If the maintainer decides to pass on your pull request, they will thank you for the contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: From 95fd3774deaf503d0e78bb46fe78275e3b6d7843 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:21:27 +0200 Subject: [PATCH 09/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 0d96f0850..1b44ce8dc 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -78,9 +78,8 @@ Adding or changing tests is an integral part of making a change to the code. The - CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code - One or more maintainers will use GitHub's review feature to review your pull request - If the maintainer asks for any changes, edit your changes, push, and ask for another review -- If the maintainer decides to pass on your pull request, they will thank you for the -contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: -- If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release +- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action +> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart: ## Provide support on issues From 14274b54cb9f8e815a7abe301686eb7c45a21d98 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:22:15 +0200 Subject: [PATCH 10/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 1b44ce8dc..46468350d 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -95,7 +95,7 @@ Helping out other users with their questions is an awesome way of contributing t *Some notes on picking up support issues:* - Avoid responding to issues you don't know you can answer accurately -- Try to refer to past issues with accepted answers as much as possible. Link to them from your replies with the #123 format +- Try to refer to past issues with accepted answers as much as possible. Link to them from your replies - Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* From 76faaf8531c56459fe47da66a2f89b92bf160e29 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:23:14 +0200 Subject: [PATCH 11/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 46468350d..d74d9bff4 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -96,7 +96,9 @@ Helping out other users with their questions is an awesome way of contributing t - Avoid responding to issues you don't know you can answer accurately - Try to refer to past issues with accepted answers as much as possible. Link to them from your replies -- Be kind and patient with users -- often, folks who have run into confusing things might be upset or impatient. This is ok. Try to understand where they're coming from, and if you're too uncomfortable with the tone, feel free to stay away or withdraw from the issue. *(note: if the user is outright hostile or is violating the CoC, refer to the [Code of Conduct](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md) to resolve the conflict)* +- Be kind and patient with users. Often, folks who have run into confusing things might be upset or impatient. This is natural. If you feel uncomfortable in conversation with them, it's better to stay away or withdraw from the issue. + + > If some user is violating our code of conduct [standards](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md#our-standards), refer to the [Enforcement](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md#enforcement) section of the Code of Conduct to resolve the conflict ## Review pull requests From 481b13a4cc08116a2f863a7c987dcdc6a30d6e66 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:23:31 +0200 Subject: [PATCH 12/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index d74d9bff4..87d239eb5 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -104,7 +104,7 @@ Helping out other users with their questions is an awesome way of contributing t ## Review pull requests -Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) -- always respond with respect, be understanding, but don't feel like you need to sacrifice your standards for their sake, either. +Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) Please, always respond with respect, and be understanding, but don't feel like you need to sacrifice your standards for their sake, either. **How to review:** From 978085939e037b3723bdbc15bec20639330494ce Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:23:52 +0200 Subject: [PATCH 13/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 87d239eb5..77c394ac2 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -110,5 +110,6 @@ Another great way to contribute is pull request reviews. Please, be extra kind: - Go to the [pull requests](https://github.com/actions/setup-go/pulls) - Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.) -- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. (Note: You may ask for minor changes ("nitpicks"), but consider whether they are real blockers to merging or not) +- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. +> Note: You may ask for minor changes - "nitpicks", but consider whether they are real blockers to merging or not - Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file From ff877a8139b4535f5165016316a4d1351084634a Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:26:15 +0200 Subject: [PATCH 14/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 77c394ac2..c7ef5c4fa 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -34,7 +34,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. **Once you've filed the pull request:** - Maintainers will review your pull request -- If the maintainer asks for any changes, edit your changes, push, and ask for another review +- If a maintainer requests changes, first of all, try to think about this request critically and only after that implement and request another review - If the maintainer decides to pass on your pull request, they will thank you for the contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: - If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release From f9b96e04335a2bd63ce40d79ada9a237228fa068 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:27:29 +0200 Subject: [PATCH 15/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index c7ef5c4fa..9f7b84794 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -75,7 +75,7 @@ Adding or changing tests is an integral part of making a change to the code. The **Once you've filed the pull request:** -- CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can make changes to your code +- CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can open them one by one, try to find the reason for failing and make changes to your code to resolve the problem - One or more maintainers will use GitHub's review feature to review your pull request - If the maintainer asks for any changes, edit your changes, push, and ask for another review - If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action From bf3c3cc849a5655f2de2e780037b6b39c2152bce Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:27:41 +0200 Subject: [PATCH 16/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index 9f7b84794..83eb36fa8 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -76,7 +76,7 @@ Adding or changing tests is an integral part of making a change to the code. The **Once you've filed the pull request:** - CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can open them one by one, try to find the reason for failing and make changes to your code to resolve the problem -- One or more maintainers will use GitHub's review feature to review your pull request +- Maintainers will review your pull request - If the maintainer asks for any changes, edit your changes, push, and ask for another review - If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action > Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart: From 44a19cee0ef8b1d8334d6e748a39c01657d5d50e Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:28:21 +0200 Subject: [PATCH 17/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 83eb36fa8..c2f56990b 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -35,9 +35,8 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Maintainers will review your pull request - If a maintainer requests changes, first of all, try to think about this request critically and only after that implement and request another review -- If the maintainer decides to pass on your pull request, they will thank you for the -contribution and explain why they won't be accepting the changes. That's ok! We still really appreciate you taking the time to do it, and we don't take that lightly :heart: -- If your PR gets accepted, it will be merged into the latest branch soon after. Your contribution will be distributed to the masses next time the maintainers tag a release +- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action +> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart: ## Contribute code From 185e7f2f01888e14b9d1229676cdc0afc55bb640 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:28:50 +0200 Subject: [PATCH 18/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index c2f56990b..b2b1168ea 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -54,7 +54,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request - **Run `pre-checkin` script to format, build and test changes** - Make sure your changes are well formatted and that all tests are passing -- If your pull request is connected to an open issue, add a line in your pull request's description that says Fixes: #123, where #123 is the number of the issue you're fixing. +- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated **Learn more about how to work with the repository:** From 4a0c0815119419a1d39be7de9decea5c7bf69c41 Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:29:14 +0200 Subject: [PATCH 19/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index b2b1168ea..fbdcacaa7 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -61,7 +61,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder - To comply with the code style, **you need to run the `format` script** -- To compile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build +- To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build - You can also start formatting, building code, and testing with a single `pre-checkin` command **Learn more about how to implement tests:** From f3e3b7c2f24007d1b1bb9d1ffbfadcc17d2f974b Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii <102794661+e-korolevskii@users.noreply.github.com> Date: Mon, 25 Jul 2022 12:29:26 +0200 Subject: [PATCH 20/21] Update docs/contributors.md Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> --- docs/contributors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors.md b/docs/contributors.md index fbdcacaa7..5ca1e0152 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -76,7 +76,7 @@ Adding or changing tests is an integral part of making a change to the code. The - CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can open them one by one, try to find the reason for failing and make changes to your code to resolve the problem - Maintainers will review your pull request -- If the maintainer asks for any changes, edit your changes, push, and ask for another review +- If a maintainer requests changes, first of all, try to think about his request critically and only after that implement and request another review - If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action > Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart: From edd0aca6b152744879d153e0e9c2d26e1c20790b Mon Sep 17 00:00:00 2001 From: Evgenii Korolevskii Date: Tue, 26 Jul 2022 09:21:29 +0200 Subject: [PATCH 21/21] update tests path --- docs/contributors.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributors.md b/docs/contributors.md index 5ca1e0152..a0588b07d 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -66,7 +66,8 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. **Learn more about how to implement tests:** -Adding or changing tests is an integral part of making a change to the code. The tests are located in the `__tests__` folder and cover most of the functionality of the repository. +Adding or changing tests is an integral part of making a change to the code. +Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder (in particular, in the file [versions.yml](https://github.com/actions/setup-go/blob/main/.github/workflows/versions.yml)). - The contributor can add various types of tests (like unit tests or end-to-end tests), which, in his opinion, will be necessary and sufficient for testing new or changed functionality - Tests should cover a successful execution, as well as some edge cases and possible errors @@ -111,4 +112,4 @@ Another great way to contribute is pull request reviews. Please, be extra kind: - Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.) - Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. > Note: You may ask for minor changes - "nitpicks", but consider whether they are real blockers to merging or not -- Submit your review, which may include comments, an approval, or a changes request \ No newline at end of file +- Submit your review, which \ No newline at end of file