From 44213bfff20d71dea92605d2424a312fa8c0928e Mon Sep 17 00:00:00 2001 From: Henry Lee Date: Mon, 29 Apr 2024 20:02:40 +1000 Subject: [PATCH] New CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- README.md | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee8794e..6dc024f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index e62683e..46bfd8a 100644 --- a/README.md +++ b/README.md @@ -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).