-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve contribution documentation (#95)
* Add contributing guide * Add recommended vscode extensions * Move list of contributors to the bottom It's also available [here](https://github.com/nikitastupin/clairvoyance/graphs/contributors), as well as through `git shortlog -sne` and other means. This commit is not intended to diminish contributions of these people, but to make README.md cleaner, so people can find it more useful. I appreciate efforts of everyone involved in the project. * Add poetry configuration to contributing docs * doc: add details near ref to contributing guide * Doc: Change IDE recommendation wording * edits --------- Co-authored-by: Nikita Stupin <18281368+nikitastupin@users.noreply.github.com>
- Loading branch information
1 parent
2c28c8e
commit 3da97d0
Showing
3 changed files
with
64 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing to Clairvoyance | ||
|
||
**Clairvoyance** is an open-source project. We appreciate your contributions! | ||
|
||
## Issues | ||
|
||
If you have encountered a bug or want to propose an idea, you can open [a new issue on GitHub](https://github.com/nikitastupin/clairvoyance/issues/new). | ||
|
||
### Best Practices | ||
|
||
1. Check for existing issues before opening a new one. If you find a similar one, add more details to it instead of creating a duplicate. | ||
2. Use relevant template and follow it. | ||
3. Add relevant details, it helps us in triaging and further steps. | ||
|
||
## Code Contribution | ||
|
||
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. | ||
|
||
### Developer Environment Setup | ||
|
||
To resolve dependencies, execute the following commands in your terminal: | ||
|
||
```shell | ||
python -m pip install pipx | ||
pipx ensurepath | ||
pipx install poetry | ||
poetry config virtualenvs.in-project true | ||
poetry install | ||
``` | ||
|
||
We use [VSCodium](https://vscodium.com/#install) and VSCode IDEs with extension in the [`.vscode/extensions.json` file](../.vscode/extensions.json). Having said that, you might use other tools as long as the outcome follows the guidelines of this project. | ||
|
||
### Git Branches | ||
|
||
Always use dedicated git branches for fixes or features instead of working directly on the main branch. | ||
|
||
### Further Information | ||
|
||
Please refer to our [Development guide](https://github.com/nikitastupin/clairvoyance/wiki/Development) for guidance on testing, code style and more. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"recommendations": [ | ||
"ms-python.debugpy", | ||
"ms-python.pylint", | ||
"ms-python.black-formatter", | ||
"ms-python.mypy-type-checker", | ||
"ms-python.isort" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters