readme: reorganize with CONTRIBUTING page

Move content related to getting help and creating issues into the
README and reference the new CONTRIBUTING page for contributing
info.

Signed-off-by: Dan Walkes <danwalkes@boulderai.com>
This commit is contained in:
Dan Walkes
2020-12-12 13:47:15 -07:00
committed by Matt Madison
parent 8f6c85b486
commit 179809a73a
2 changed files with 38 additions and 29 deletions

View File

@@ -1,34 +1,10 @@
Thank you for contributing to the OE4T project! Your contributions are greatly
appreciated!
# Getting Help
For general build issues or questions about getting started with your build
setup please use the
[Discussions](https://github.com/OE4T/meta-tegra/discussions) tab of the
meta-tegra repository:
Submitting Code Changes
------------
* Use the Ideas category for anything you'd like to see included in meta-tegra,
Wiki content, or the
[tegra-demo-distro](https://github.com/OE4T/tegra-demo-distro/issues).
* Use the Q&A category for questions about how to build or modify your Tegra
target based on the content here.
* Use the "Show and Tell" category for any projects you'd like to share which
are related to meta-tegra.
* Use the General channel for anything that doesn't fit well into the categories
above, and which doesn't relate to a build or runtime issue with Tegra yocto
builds.
# Reporting Issues
Use the [Issues tab in meta-tegra](https://github.com/OE4T/meta-tegra/issues)
for reporting build or runtime issues with Tegra yocto build targets. When
reporting build or runtime issues, please include as much information about your
environment as you can. For example, the target hardware you are building for,
branch/version information, etc. Please fill in the provided bug template when
reporting issues.
# Submitting Code Changes
The OE4T project repositories follow the [OpenEmbedded
Guidelines](https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines#Patch_Headers_and_Commit_Messages).
Please review these when proposing your Pull Request. A few highlights and
@@ -70,7 +46,10 @@ involved.
(Adapted from the [Linux kernel's certificate of origin](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1).)
# Submitting Documentation Changes
Submitting Documentation Changes
------------
Wikis are enabled on the [meta-tegra](https://github.com/OE4T/meta-tegra) and
[tegra-demo-distro](https://github.com/OE4T/tegra-demo-distro) repositories.
Please feel free to make appropriate changes to pages as needed, adding an edit

View File

@@ -66,10 +66,40 @@ PLEASE NOTE
builds and configuring them for GCC 8.
Getting Help
-----------
For general build issues or questions about getting started with your build
setup please use the
[Discussions](https://github.com/OE4T/meta-tegra/discussions) tab of the
meta-tegra repository:
* Use the Ideas category for anything you'd like to see included in meta-tegra,
Wiki content, or the
[tegra-demo-distro](https://github.com/OE4T/tegra-demo-distro/issues).
* Use the Q&A category for questions about how to build or modify your Tegra
target based on the content here.
* Use the "Show and Tell" category for any projects you'd like to share which
are related to meta-tegra.
* Use the General channel for anything that doesn't fit well into the categories
above, and which doesn't relate to a build or runtime issue with Tegra yocto
builds.
Reporting Issues
-----------
Use the [Issues tab in meta-tegra](https://github.com/OE4T/meta-tegra/issues)
for reporting build or runtime issues with Tegra yocto build targets. When
reporting build or runtime issues, please include as much information about your
environment as you can. For example, the target hardware you are building for,
branch/version information, etc. Please fill in the provided bug template when
reporting issues.
Contributing
------------
Please see the contributor wiki page at
[this link](https://github.com/OE4T/meta-tegra/wiki/OE4T-Contributor-Guide).
Please see [CONTRIBUTING.md](CONTRIBUTING.md)
Contributions are welcome!