Skip to content

Update contributors guide #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marko-zivic-93 merged 5 commits into from
Aug 10, 2022
Merged

Update contributors guide #555

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
18090de
updated docs
e-korolevskii Jul 31, 2022
0d3aa68
format
e-korolevskii Jul 31, 2022
5d6bb12
rephased documents
e-korolevskii Aug 3, 2022
dbb54d0
Update docs/contributors.md
e-korolevskii Aug 9, 2022
5bbf722
Merge branch 'actions:main' into update-contributors-guide
e-korolevskii Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs/contributors.md 
Co-authored-by: Ivan <[email protected]>
  • Loading branch information
@e-korolevskii @IvanZosimov
e-korolevskii and IvanZosimov authored Aug 9, 2022
commit dbb54d08f2fd255751eb4ada17574f3caee8f5fc
2 changes: 1 addition & 1 deletion docs/contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ 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.
Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder (in the particular file [e2e-cache.yml](https://github.com/actions/setup-node/blob/main/.github/workflows/e2e-cache.yml)).
Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder, particularly in the [versions.yml](https://github.com/e-korolevskii/setup-node/blob/update-contributors-guide/.github/workflows/versions.yml) and [e2e-cache.yml](https://github.com/actions/setup-node/blob/main/.github/workflows/e2e-cache.yml) files.

- 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
Expand Down