Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

Commit d852daf

Browse files
committed
Add contributing doc
Signed-off-by: Serhii Horodilov <sgorodil@gmail.com>
1 parent 5f4e5fc commit d852daf

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing to the Problem Sets Repository
2+
3+
Welcome to the Training Repository! We welcome all contributions from
4+
the community. Please take a moment to review this guide before getting
5+
started.
6+
7+
## Getting Started
8+
9+
1. Fork the repository to your own GitHub account.
10+
2. Clone the repository to your local machine.
11+
3. Install project dependencies
12+
4. Create a new branch with a descriptive name for your feature or bug fix.
13+
14+
## Making Changes
15+
16+
1. Make changes to the code, documentation, or any other aspect of
17+
the repository.
18+
2. Commit your changes with a clear and descriptive commit message.
19+
3. Push your changes to your forked repository.
20+
4. Create a pull request to the main repository, detailing your changes
21+
and their impact.
22+
23+
## Code Style
24+
25+
We follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) code
26+
style guide. Please ensure your code adheres to these standards.
27+
28+
## Testing
29+
30+
Before submitting your pull request, please ensure that all tests pass.
31+
We use [pytest](https://docs.pytest.org) for testing.
32+
To run the tests, use the command:
33+
34+
```shell
35+
pytest
36+
```
37+
38+
Thank you for your contributions to the Training Repository!

0 commit comments

Comments
 (0)