Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move contributing page into repo and add issue template #520

Merged
merged 4 commits into from
Dec 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/meta-tegra-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: meta-tegra bug report
about: Create a report to help us improve meta-tegra
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

Not a bug? Review the [CONTRIBUTING.md](CONTRIBUTING.md) file for other ways to get help or feedback.

**To Reproduce**
Steps to reproduce the behavior:
1. Build meta-tegra branch '...' with MACHINE based on '...'
2. Build with bitbake argument '...'
3. Deploy to hardware with method '...'
4. See error '...' with link to any relevant logs at '...'

**Additional context**
Add any other context about the problem here.
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Thank you for contributing to the OE4T project! Your contributions are greatly
appreciated!


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
additional requirements:
* Please submit issues or pull requests through Github. Only rebase and squash
commits are used for PRs, so if you have a PR that is outstanding for a long
time, please keep your branch up to date by rebasing your changes, rather than
merging.
* Group commits based on their functionality and components changed. For the
first line, use something like `component: Short Summary` to describe your
change where `component` refers to a specific software component being changed.
* Please try to make incremental changes with multiple commits, rather than "big
bang" single commits with changes spread across multiple components.
* Add a `Signed-off-by:` line to your commit, using `git commit -s` or a
pre-commit hook like the one setup with [this script](https://github.com/OE4T/tegra-demo-distro/blob/master/scripts-setup/setup-git-hooks),
using your real name and e-mail address (no anonymous contributions, please).
This indicates that you have the right to submit the patch per the
Developer's Certificate of Origin in the next section.
* Target the master branch for pull requests unless your change is specific
to an earlier branch.

## Developer's Certificate of Origin
By making a contribution to this project, I certify that:
1. The contribution was created in whole or in part by me and I have the right
to submit it under the open source license indicated in the file; or
2. The contribution is based upon previous work that, to the best of my
knowledge, is covered under an appropriate open source license and I have the
right under that license to submit that work with modifications, whether
created in whole or in part by me, under the same open source license
(unless I am permitted to submit under a different license),
as indicated in the file; or
3. The contribution was provided directly to me by some other person who
certified (1), (2) or (3) and I have not modified it.
4. I understand and agree that this project and the contribution are public and
that a record of the contribution (including all personal information I submit
with it, including my sign-off) is maintained indefinitely and may be
redistributed consistent with this project or the open source license(s)
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
------------

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
message to describe your change.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!