diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-08-04 16:40:44 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-09-13 16:15:59 +0200 |
| commit | fdc3200ef4718eb98bd8a713f956222a9bf85ac9 (patch) | |
| tree | 4fa8e5998bd4ee59397b26222846c554b73abe4e /site/community/2-contributing.md | |
| parent | 8a94318aad4b4fa188ac49e887d564867a00111e (diff) | |
docs: Add initial version of Docusaurus based docs
This change updates the repository with a new Docusaurus-based
documentation website. This allows us to create our documentation using
Markdown, MDX and React. This will serve as the main entry point for
users visiting https://opendc.org. The actual OpenDC application will be
moved to https://app.opendc.org.
Diffstat (limited to 'site/community/2-contributing.md')
| -rw-r--r-- | site/community/2-contributing.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/site/community/2-contributing.md b/site/community/2-contributing.md new file mode 100644 index 00000000..36cd5cb5 --- /dev/null +++ b/site/community/2-contributing.md @@ -0,0 +1,36 @@ +--- +title: Contributing +hide_title: true +sidebar_label: Contributing +--- + +# Contributing to OpenDC + +First of all, thank you for wanting to contribute to OpenDC! +You can contribute in various meaningful ways: + +* Report a bug through [GitHub issues](https://github.com/fabianishere/atlarge-research/issues). +* Propose new functionality for using this project. +* Contribute improvements to the code and documentation. +* Provide feedback about how we can improve the project. +* Help answer questions on our [Discussions](https://github.com/atlarge-research/discussions) page. + +## Want to report a bug or suggest a feature? + +Please file an issue! First, have a look if someone has already filed an issue addressing your concern. If there already +is such an issue, feel free to comment on the issue to show your support for it, or to add additional information that +might be helpful. You can also just react with a thumbs-up 👍 to the issue, to indicate that you'd be interested in its +resolution. This can help us prioritize what we spend our development time on. + +If you can't find an issue that fits your problem or feature request, open a new one. Describe actual and expected +behavior, and be as detailed as you can. We'll get back to you asap! + +## Want to contribute code? + +That's great! If you want to contribute to this +repository, [fork it](https://github.com/atlarge-research/opendc/new/master) and submit a pull request here when you're +ready! Be sure to describe *what* you changed and *why* you changed it, to help us understand what your contribution is +about. + +A quick note on commit messages: Please follow common Git standards when writing commit messages, +see [this post](https://cbea.ms/git-commit/) for details. |
