add contribution guidelines #132
Conversation
There was a problem hiding this comment.
That's great though to create a file like this. I only may suggest creating a special template instead of this file. So all contributors will see these guidelines automatically at the moment of creating PR.
| We invite you to collaborate on ensuring the quality of contributions by folowing several essential rules. | ||
|
|
||
| - **Use pull requests**. Automated assignee selection should work fine. When in doubt, please assign the PRs to @vovak, @egor-bogomolov, or @spirinegor. | ||
| - **Keep the code clean.** Please use the "Reformat code" IDE action on all modified code, do not ignore IDE or compiler warnings. |
There was a problem hiding this comment.
It's better to add detekt to dependencies and run it on every push. For example, PSIMiner uses it.
|
|
||
| We invite you to collaborate on ensuring the quality of contributions by folowing several essential rules. | ||
|
|
||
| - **Use pull requests**. Automated assignee selection should work fine. When in doubt, please assign the PRs to @vovak, @egor-bogomolov, or @spirinegor. |
There was a problem hiding this comment.
Are name links clickable? In preview, they not...
Also, can you call me @SpirinEgor, this would divide name and surname and make it more readable.
| - **Use pull requests**. Automated assignee selection should work fine. When in doubt, please assign the PRs to @vovak, @egor-bogomolov, or @spirinegor. | ||
| - **Keep the code clean.** Please use the "Reformat code" IDE action on all modified code, do not ignore IDE or compiler warnings. | ||
| - **Write unit tests**. This is particularly important when adding new features to the core modules to ensure that subsequent changes do not break anything. | ||
| - **Keep the build green.** Adding support for external tools might involve adding new dependencies and modifying the build process. Please make sure that external dependencies are either included as package dependencies or are otherwise installed during the build of `astminer` without modifying the system environment outside the folder of this repository. Please do not assume any additional environment requirements in the CI build so that it represents a build on a freshly cloned repository. |
There was a problem hiding this comment.
In the current paradigm of GumTree, it's not possible to add all dependencies in Gradle. We can provide scripts for installing additional dependencies, but
- Not all users need to run it in order to work with ASTMiner (e.g. not everybody need to install pythonparser)
- Installing other dependencies would change the user environment, PATH variable, or something else. This is not good.
Of course, what you write here is absolutely correct. I just want to point that there is a lot of work for us to provide the ability to run all tests on CI and run the only subset local based on user environment.
No description provided.