Skip to content

Commit 5a09857

Browse files
committed
Update README
1 parent 4eb27dc commit 5a09857

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,31 @@ See the [open issues](https://github.com/dirkbrnd/resistance_coup/issues) for a
7171
## Contributing
7272

7373
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
74-
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/dirkbrnd/resistance_coup/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
74+
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/dirkbrnd/resistance_coup/issues/new) to discuss it, or directly create a pull request.
7575
* Please make sure you check your spelling and grammar.
7676
* Create individual PR for each suggestion.
7777

78+
### Local setup for development
79+
After you have cloned the repo:
80+
81+
1. Install the game
82+
83+
```sh
84+
poetry install
85+
```
86+
87+
2. Set up the pre-commit hooks
88+
89+
```sh
90+
pre-commit install
91+
```
92+
93+
3. Make your changes on a branch and create a PR!
94+
95+
7896
### Creating A Pull Request
7997

80-
1. Fork the Project
98+
1. Clone the Project
8199
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
82100
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
83101
4. Push to the Branch (`git push origin feature/AmazingFeature`)

0 commit comments

Comments
 (0)