Skip to content

Commit

Permalink
Update documentation and fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
SokolovaNastya committed Jun 27, 2024
1 parent 3f46b7b commit 6431939
Show file tree
Hide file tree
Showing 21 changed files with 846 additions and 471 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Сode contribution workflow

1. Find an open issue or create a new issue on issue tracker for the feature you want to contribute.
2. Fork the project on GitHub. You need to create a feature-branch for your work on your fork, as this way you be able to submit a pull request.
3. Make any necessary changes to the source code.
4. Add tests that verify that your contribution works as expected and modify existing tests if required.
5. Run all tests and make sure all of them pass.
6. Run code coverage to check if the lines of code you added are covered by unit tests.
7. Once your feature is complete, prepare the commit with appropriate message and the issue number.
8. **Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) and wait for the users to review. When you submit a pull request, please, agree to the terms of [CLA](CLA.md).**
# Code contribution workflow

1. Find an open issue or create a new issue on issue tracker for the feature you want to contribute.
2. Fork the project on GitHub. You need to create a feature-branch for your work on your fork, as this way you be able to submit a pull request.
3. Make any necessary changes to the source code.
4. Add tests that verify that your contribution works as expected and modify existing tests if required.
5. Run all tests and make sure all of them pass.
6. Run code coverage to check if the lines of code you added are covered by unit tests.
7. Once your feature is complete, prepare the commit with appropriate message and the issue number.
8. **Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) and wait for the users to review. When you submit a pull request, please, agree to the terms of [CLA](CLA.md).**
9. Once everything is done, your pull request gets merged. Your feature will be available with the next release and your name will be added to AUTHORS.
Loading

0 comments on commit 6431939

Please sign in to comment.