From 86c19c6ad86054dd103ea0968d71f40593ce2a75 Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Tue, 30 Aug 2022 14:52:31 -0400 Subject: [PATCH] Link to contribution page in the docs Tried to move the outline over and get some stuff started. This is pretty rough. --- CONTRIBUTING.md | 28 ++++++------------- intro/contribution/index.rst | 53 +++++++++++++++++++++++++++++++++++- 2 files changed, 61 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7946a6f5..5ca37905 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,30 +2,20 @@ **First off, thanks for taking the time to think about contributing!** -The following is a set of guidelines for contributing to docs.beagleboard.io, which is hosted by the BeagleBoard.org Foundation at https://git.beagleboard.org/docs/docs.beagleboard.io. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. +The following is a set of guidelines for contributing to docs.beagleboard.io, which is hosted by +the BeagleBoard.org Foundation at https://git.beagleboard.org/docs/docs.beagleboard.io. These are +mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this +document in a pull request. ## Code of Conduct -This project and everyone participating in it is governed by the [BeagleBoard.org Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or contact one of the administrators on https://forum.beagleboard.org. +This project and everyone participating in it is governed by +the [BeagleBoard.org Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to +uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or +contact one of the administrators on https://forum.beagleboard.org. ## FAQ * [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19) -## What should I know before I get started? - -## How can I contribute? - -### Reporting bugs - -### Suggesting enhancements - -### Submitting pull requests - -## Style guides - -### Git commit messages - -### RST style guide - -## Additional notes +See more at https://docs.beagleboard.org/en/latest/intro/contribution/. diff --git a/intro/contribution/index.rst b/intro/contribution/index.rst index 3a1cb77a..83fedd49 100644 --- a/intro/contribution/index.rst +++ b/intro/contribution/index.rst @@ -3,7 +3,58 @@ Contribution ############### -.. note:: This section is under developmement right now. +.. note:: + This section is under developmement right now. + +.. important:: + First off, thanks for taking the time to think about contributing! + +The BeagleBoard.org Foundation maintains source for many open source projects. + +Example projects suitable for first contributions: +* `BeagleBoard project documentation <https://git.beagleboard.org/docs/docs.beagleboard.io>`__ +* `Debian image bug repository <https://git.beagleboard.org/beagleboard/Latest-Images>`__ +* `Debian image builder <https://git.beagleboard.org/beagleboard/image-builder>`__ + +These guidelines are mostly suggestions, not hard-set rules. Use your best judgment, and feel free +to propose changes to this document in a pull request. + +Code of Conduct +*************** + +This project and everyone participating in it is governed by +the `BeagleBoard.org Code of Conduct </intro/contribution/code_of_conduct.html>`. By +participating, you are expected to +uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or +contact one of the administrators on https://forum.beagleboard.org. + +## FAQ + +* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19) + +What should I know before I get started? +**************************************** + +How can I contribute? +********************* + +Reporting bugs +=============== + +Suggesting enhancements +======================= + +Submitting pull requests +======================== + +Style guides +************ + +* Git commit messages +* `RST style guide </intro/contribution/style.html>`__ + +Additional notes +**************** .. toctree:: :maxdepth: 1 -- GitLab