Skip to content

Commit

Permalink
edits
Browse files Browse the repository at this point in the history
  • Loading branch information
nikitastupin committed May 27, 2024
1 parent 990b4b4 commit e7f4426
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@

## Issues

If you have encountered an bug or want to propose your idea, you can open a new issue on the github.
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

### 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
## 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
Expand All @@ -26,10 +28,12 @@ poetry config virtualenvs.in-project true
poetry install
```

We use [VSCodium](https://vscodium.com/#install)/VSCode IDE with [some extensions](../.vscode/extensions.json). Having said that, you might use other tools as long as the outcome follows the guidelines of this project.
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 master branch.

### Further information
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.

0 comments on commit e7f4426

Please sign in to comment.