Skip to content

Commit 27ed54b

Browse files
committed
doc: add Contributing section in README
Add Contributing section in README that describes CoC, Contributing guide and Technical Charter.
1 parent da394b9 commit 27ed54b

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,20 @@ The project is also present on several social media platforms:
152152
* Bluesky: [@EnvModules.bsky.social][9]
153153

154154

155-
Code of conduct
156-
---------------
155+
Contributing
156+
------------
157+
158+
Modules project welcomes contributions of all kinds! Before submitting an
159+
issue or pull request, please take a moment to review our [Contributing
160+
guide][10]. It includes important information about issue reporting, coding
161+
standards, etc.
162+
163+
Please note that Modules project has a [Code of conduct][11]. It ensures a
164+
respectful and inclusive environment for all contributors. By participating in
165+
the Modules community, you agree to abide by its rules.
157166

158-
Please note that Modules has a [Code of conduct][10]. By participating in the
159-
Modules community, you agree to abide by its rules.
167+
This project also adheres to a [Technical charter][12], which defines its
168+
governance model, decision-making process, and long-term vision.
160169

161170

162171
Authors
@@ -165,13 +174,13 @@ Authors
165174
Modules current core developer and maintainer is Xavier Delaruelle,
166175
167176

168-
Many thanks go to the [contributors][11] of the Modules project.
177+
Many thanks go to the [contributors][13] of the Modules project.
169178

170179

171180
Acknowledgments
172181
---------------
173182

174-
We would like to express our gratitude to [CEA][12] for the resources and
183+
We would like to express our gratitude to [CEA][14] for the resources and
175184
funding provided to the project over the recent years.
176185

177186
The following people have notably contributed to Modules and Modules would not
@@ -197,6 +206,8 @@ be what it is without their contributions:
197206
[7]: https://x.com/EnvModules
198207
[8]: https://mast.hpc.social/@EnvModules
199208
[9]: https://bsky.app/profile/envmodules.bsky.social
200-
[10]: CODE_OF_CONDUCT.md
201-
[11]: https://github.com/envmodules/modules/graphs/contributors
202-
[12]: https://www.cea.fr/english
209+
[10]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
210+
[11]: CODE_OF_CONDUCT.md
211+
[12]: https://modules.readthedocs.io/en/latest/CHARTER.html
212+
[13]: https://github.com/envmodules/modules/graphs/contributors
213+
[14]: https://www.cea.fr/english

0 commit comments

Comments
 (0)