diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..7946a6f52673e80c237eaea13a06755b525a9e30 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to docs.beagleboard.io + +**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. + +## 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. + +## 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 diff --git a/README.md b/README.md index 1c283522ed6c797dfff2310c89c665775e94c765..12ccb79c0b6fa3b3fcadf85caa1113e6d8d6f914 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # docs.beagleboard.io - + + +This project seeks to document the design and usage of BeagleBoard.org boards. + +Priority is given to the out-of-box Debian Linux software images, but additional well-maintained software projects supporting these boards are welcome to be documented here as well. + +This project seeks to provide a more authoritative and easy to consume set of documentation than is available through wiki pages, but still encourages community contributions. Issues and pull requests will be reviewed for accuracy. + +The project will have release versions and archive those specific versions for future reference. The stable release versions will be published at https://docs.beagleboard.org. The latest output is hosted at https://docs.beagleboard.io and source is maintained at https://git.beagleboard.org/docs/docs.beagleboard.io. * [COPYING](COPYING) * [LICENSE](LICENSE) -* [CONTRIBUTING](CONTRIBUTING) +* [CONTRIBUTING](CONTRIBUTING.md)