Skip to content

Commit a98a470

Browse files
authored
Create CONTRIBUTING.md
1 parent c71a2df commit a98a470

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contribution
2+
3+
We welcome contributions from everyone.
4+
5+
If you want to contribute, a good starting point is to get in touch with us through:
6+
- github (discussion, issues or pull-request)
7+
- the project [discord](https://discord.gg/cYsYrPT)
8+
- mail (see current corresponding author from the grid2op package on pypi here https://pypi.org/project/Grid2Op/)
9+
10+
Contribution can take different forms:
11+
12+
- reporting bugs
13+
- improving the documentation
14+
- improving the code examples (notebooks or example in the doc)
15+
- fixing some reported issues (for example at https://github.com/rte-france/Grid2Op/issues )
16+
- adding a new functionality to grid2op (or increase its speed)
17+
- extend grid2op
18+
19+
# What to do ?
20+
21+
For smaller changes (including, but not limited to the reporting of a bug or a contribution to the explanotory notebooks or the documentations)
22+
a simple "pull request" with your modifications by detailing what you had in mind and the goal of your changes.
23+
24+
In case of a major change (or if you have a doubt on what is "a small change"), please open an issue first
25+
to discuss what you would like to change and then follow as closely as possible the guidelines below. This is to ensure
26+
first that no other contribution is this direction is being currently made but also to make sure that it
27+
does not conflicts with some core ideas of the project.
28+
29+
# Guidelines for contributing to the codebase
30+
31+
For larger contributions, you can follow the given :
32+
33+
1. fork the repository located at <https://github.com/rte-france/Grid2Op>
34+
2. synch your fork with the "latest developement branch of grid2op". For example, if the latest grid2op release
35+
on pypi is `1.10.3` you need to synch your repo with the branch named `dev_1.10.4` or `dev_1.11.0` (if
36+
the branch `dev_1.10.4` does not exist). It will be the highest number in the branches `dev_*` on
37+
grid2op official github repository.
38+
3. implement your functionality / code your modifications, add documentation or any kind of contribution
39+
4. make sure to add tests and documentation if applicable
40+
5. once it is developed, synch your repo with the last development branch again (see point 2 above) and
41+
make sure to solve any possible conflicts
42+
6. write a pull request and make sure to target the right branch (the "last development branch")
43+
44+
# When will it be merged ?
45+
46+
A contribution will be merged once approved by the maintainers (this is why it is recommended to first
47+
get in touch with the team)
48+
49+
Code in the contribution should pass all the current tests, have some dedicated tests for the new feature (if applicable)
50+
and documentation (if applicable).
51+
52+
New contributions should respect the "**Code of Conduct**" of grid2op.

0 commit comments

Comments
 (0)