diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2022-09-13 17:28:57 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-13 17:28:57 +0200 |
| commit | ff7dfda051e0103b0df453473eb0f08cdc37ae85 (patch) | |
| tree | 2e80525809ecb5afe010faa99898ca479965b95a /site/community/2-contributing.md | |
| parent | fde9ba4fb88bada9d9873ba21904e9e1a66b0c46 (diff) | |
| parent | fd208941622cd559a0c3a196a0754a1b33db402b (diff) | |
merge: Add documentation using Docusaurus (#97)
This pull request implements the new OpenDC documentation website using Docusaurus 2.
## Implementation Notes :hammer_and_pick:
* Add initial Docusaurus website.
* Migrate existing docs to Docusaurus.
* Configure Prettier for Docusaurus.
* Add tutorials to OpenDC website (#28)
* Add deployment workflow via GitHub actions
## External Dependencies :four_leaf_clover:
* Docusaurus 2
Closes #28
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. |
