Skip to content

Commit d2aa4db

Browse files
add contributing code guidelines to documentation
1 parent f01785d commit d2aa4db

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

doc/developer.contributing.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,38 @@ When reporting a bug, please be sure to include the following:
2222
sample game file or files if appropriate; it is often helpful to
2323
simplify the game if possible.
2424

25+
Contributing code
26+
----------------
27+
28+
Gambit is an open-source project, and contributions are welcome from anyone.
29+
The project is hosted on GitHub, and contributions can be made via pull requests following the standard GitHub workflow.
30+
31+
1. To get started contributing code in the `Gambit GitHub repo <https://github.com/gambitproject/gambit>`__, do one of the following:
32+
33+
- Core developers: request contributor access from one of the `team <https://www.gambit-project.org/team/>`__
34+
- External contributors: fork the repository on GitHub.
35+
36+
2. Clone the repository to your local machine ::
37+
38+
git clone https://github.com/gambitproject/gambit.git # or your fork URL
39+
cd gambit
40+
41+
3. Create a new branch for your changes ::
42+
43+
git checkout -b feature/your-feature-name
44+
45+
4. Make your changes. Commit each change with a clear commit message ::
46+
47+
git add .
48+
git commit -m "Add feature X or fix bug Y"
49+
50+
5. Push your changes to your fork or branch ::
51+
52+
git push origin feature/your-feature-name
53+
54+
6. Open a pull request on GitHub to the master branch of the upstream repository, describing your changes and linking to any relevant issues.
55+
7. Core developers will review your changes, provide feedback, and merge them into the master branch if they meet the project's standards.
56+
2557
Editing this documentation
2658
--------------------------
2759

0 commit comments

Comments
 (0)