22
33Thank you very much if you have decided to contribute to our project.
44We follow very simple and clear open-source research community accepted guidelines for contributing.
5- The guideline instructions divided into sections depending on the part of the project you want to contribute.
5+ The guideline instructions divided into sections depending on the part of the project you want to
6+ contribute.
67
78## Rules for adding commits
89
@@ -18,41 +19,49 @@ The `<type>` field must take one of these values:
1819* ` fix ` to fix a bug in the project
1920* ` refactor ` for code refactoring, such as renaming a variable
2021* ` test ` to add tests, refactor them
21- * ` struct ` for changes related to a change in the structure of the project (BUT NOT CODE), for example, changing
22- folder locations
22+ * ` struct ` for changes related to a change in the structure of the project (BUT NOT CODE), for
23+ example, changing folder locations
2324* ` ci ` for various ci/cd tasks
2425* ` docs ` for changes in documentation
2526* ` chore ` for changes outside the code, for example, gitignore and reamde updates
2627
27- The ` <body> ` field contains the gist of the changes in the present imperative in English without the dot in at the end,
28+ The ` <body> ` field contains the gist of the changes in the present imperative in English without the
29+ dot in at the end,
2830the first word is a verb with a small letter.
2931
3032Examples:
3133
3234* Good: "feat: add module for future scrubber implementations"
3335* Bad: "Added module for future scrubber implementations."
3436
35- ## Source code developers guide
37+ ## Source code developers guide (members of PySATL)
3638
37- 1 . Fork this repository using your GitHub account.
38- 2 . Install ` git ` and clone your forked copy of the ` repo ` .
39- 3 . Build project following build instructions in [ README.md] ( ./README.md ) file, make sure everything is ok.
40- 4 . Run tests following instructions in [ README.md] ( ./README.md ) file, make sure all tests passing.
39+ 1 . Install ` git ` and clone this repo.
40+ 2 . Build project following build instructions in [ README.md] ( ./README.md ) file, make sure everything
41+ is ok.
42+ 3 . Run tests following instructions in [ README.md] ( ./README.md ) file, make sure all checks passing.
43+ 4 . Create new branch from main using branch naming rules.
41445 . Implement new feature or fix existing one in the source code.
42- 6 . Commit your changes.
43- 7 . Open a pull-request.
44- 8 . Wait for review from developers of the project.
45- 9 . Fix major and minor issues if presented.
46- 10 . Get your work merged into ` main ` !
45+ 6 . Run pre-commit and tests.
46+ 7 . Commit your changes.
47+ 8 . Open a pull-request.
48+ 9 . Wait for review from developers of the project.
49+ 10 . Fix major and minor issues if presented.
50+ 11 . Get your work merged into ` main ` !
4751
4852## Rules for collaborators
4953
50- ### Basic Tips
54+ Use the instructions for PySATL members, but use forks instead of branches. You probably won't have
55+ access to create branches in the original repository.
56+
57+ ## Basic Tips
5158
52591 . Don't use merge, only rebase (to keep a linear commit history)
53602 . Do not change other people's branches unless absolutely necessary
54613 . Recheck your commit history before creating a pull request
55- 4 . ** Check you're on the right branch** , never commit directly in main
62+ 4 . Do not use small "fix" commit if you messed up in previous ones. Use ` git commit --fixup ` and
63+ ` git rebase -i --autosquash ` or ` git commit --amend ` if bad commit is the last one. "fix" commits
64+ stand for bugs that has been already in master.
5665
5766### Rules for pull requests
5867
@@ -62,8 +71,9 @@ Each pull request must be reviewed by one of the maintainers
6271
6372* Mikhal Mikhailov ([ desiment] ( https://github.com/desiment ) )
6473* Vladimir Kutuev ([ vkutuev] ( https://github.com/vkutuev ) )
74+ * Leonid Elkin ([ LeonidElkin] ( https://github.com/LeonidElkin ) )
6575
6676If you click on the green button, then ** make sure** that it says ` REBASE AND MERGE ` !
6777
68- The review takes place in the form of comments to pull requests, discussions in the team chat and personal
69- communication.
78+ The review takes place in the form of comments to pull requests, discussions in the team chat and
79+ personal communication. Be polite and don't flood the discussions .
0 commit comments