From 8f75336cb802b770d1ac53efb155632dd2dd94d2 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Thu, 8 Apr 2021 20:59:35 +0200 Subject: docs: Revamp project documentation This change updates the project documentation by moving most of the documentation to the docs directory. --- CONTRIBUTING.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ed01f8a..e4109272 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,26 @@ # Contributing to OpenDC -First of all, thanks for wanting to contribute! 🎉 - +First of all, thank you for wanting to contribute to OpenDC! 🎉 ## 💬 Have a question or general feedback relating to OpenDC? Contact us at 📧[opendc@atlarge-research.com](mailto:opendc@atlarge-research.com)! - ## 🐞 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! +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 PR 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. +That's great! If you want to contribute to this +repository, [fork it](https://github.com/atlarge-research/opendc/new/master) and submit a PR 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://chris.beams.io/posts/git-commit/) for details. +A quick note on commit messages: Please follow common Git standards when writing commit messages, +see [this post](https://chris.beams.io/posts/git-commit/) for details. -- cgit v1.2.3