Skip to content

Commit

Permalink
New CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryRLee committed Apr 29, 2024
1 parent 7d234fb commit 44213bf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contributing

Thank you for contributing to PHEvaluator. Here are some advice might be useful for passing the code review.
Thank you for contributing to `PHEvaluator`! Here are some advices might be useful for passing the code review.

* Check out the latest code in `develop` branch. Also target your Pull Request on the `develop` branch.
* The Coding Style is to use 2-space indentations in C++, and 4-space indentations in Python. An [.editorconfig](https://github.com/HenryRLee/PokerHandEvaluator/blob/master/.editorconfig) file has also been created, which [most editors support natively](https://editorconfig.org/).
* Split your work into multiple Pull Request if they are irrelevant, so that we can merge them independently (usually with squash merge).
* If you are planning to work on a large feature, it'd be helpful if we can understand your idea first, prior to getting your hands on the implementation. You may create a new issue or a new discussion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,9 @@ An article about Monte Carlo simulation of Texas Hold'em.
[Estimating the outcome of a Texas hold’em game using Monte Carlo simulation](https://petrosdemetrakopoulos.medium.com/estimating-the-outcome-of-a-texas-holdem-game-using-monte-carlo-simulation-1be35be29036)

It's source code is in https://github.com/petrosDemetrakopoulos/TexasHoldemMonteCarloSimulation

## Contributing to this repository

All contributions are welcome. A contribution can be as small as reporting a bug by creating an issue.

If you plan to create a Pull Request, please find more details in [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit 44213bf

Please sign in to comment.