-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jiaxing Shi <[email protected]>
- Loading branch information
Showing
6 changed files
with
335 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: Bug report | ||
description: Create a report to help us improve | ||
title: Bug report | ||
labels: ["bug :bug:"] | ||
body: | ||
- type: textarea | ||
id: bug_report_description | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: bug_report_reproduce | ||
attributes: | ||
label: To reproduce | ||
description: Steps to reproduce the behavior | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: bug_report_expected_behavior | ||
attributes: | ||
label: Expected behavior | ||
description: A clear and concise description of what you expected to happen | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: bug_report_screenshots | ||
attributes: | ||
label: Screenshots | ||
description: | | ||
If applicable, add screenshots to help explain your problem | ||
Tip: You can attach images by clicking this area to highlight it and then dragging files in. | ||
- type: textarea | ||
id: bug_report_desktop | ||
attributes: | ||
label: OS (please complete the following information) | ||
placeholder: | | ||
- OS: [e.g. Ubuntu] | ||
- Version: [e.g. 22.04] | ||
- type: textarea | ||
id: bug_report_additional_context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: Feature request | ||
labels: ["feature :sparkles:"] | ||
body: | ||
- type: textarea | ||
id: feature_request_description | ||
attributes: | ||
label: Is your feature request related to a problem? Please describe. | ||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: feature_request_solution_description | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: A clear and concise description of what you want to happen | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: feature_request_alternatives | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: A clear and concise description of any alternative solutions or features you've considered | ||
- type: textarea | ||
id: feature_request_additional_context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
## Description | ||
|
||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. | ||
|
||
## Type of change | ||
|
||
Please delete options that are not relevant. | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
## How Has This Been Tested? | ||
|
||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
|
||
**Test Configuration**: | ||
* OS version: | ||
* Hardware: | ||
* SDK: | ||
|
||
## Checklist: | ||
|
||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my own code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
- [ ] Any dependent changes have been merged and published in downstream modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, caste, color, religion, or sexual | ||
identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall | ||
community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of | ||
any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, | ||
without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official email address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
[GitHub.QuIC.CoC](mailto:[email protected]?subject=GitHub%20QuIC%20Code%20of%20Conduct%20Report). | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or permanent | ||
ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the | ||
community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.1, available at | ||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
[https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# Contributing | ||
|
||
Hi there! | ||
We’re thrilled that you’d like to contribute to this project. We aim to make contributing to Qualcomm QRB ROS is easy, enjoyable, and educational for everyone. All contributions are welcome, whether they are features, issues, documentation, guides, or anything else. Your help is essential for keeping this project great and for making it better. | ||
|
||
## Contributing Guidelines | ||
Before you submit a pull request to QRB ROS project, please ensure that you have followed these guidelines: | ||
- Code should be well-documented and formatted according to the [Code style and language versions](https://docs.ros.org/en/jazzy/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html). | ||
- All changes should be covered by tests. | ||
- Commits should be well-written and descriptive, with a clear summary of the changes made and any relevant context. | ||
- Pull requests should target the `main` branch and include a clear summary of the changes made. | ||
|
||
## Bug report | ||
If you find a bug in the source code, you can help us by [submitting an issue](../../issues). Even better, you can submit a [Pull Request](../../pulls) with a fix. | ||
|
||
## New feature | ||
You can request a new feature by [submitting an issue](../../issues). | ||
<Update link with template> | ||
|
||
If you'd like to implement a new feature, it's always good to be in touch with us before you invest time and effort, since not all features can be supported. | ||
|
||
- For a Major Feature, first open an issue and outline your proposal. This will let us coordinate efforts, prevent duplication of work, and help you craft the change so that it's successfully integrated into the project. | ||
- Small Features can be crafted and directly [submitted as a Pull Request](#submitting-a-pull-request). | ||
|
||
|
||
# How to make a code contribution | ||
|
||
## Open to community | ||
You can check all the issues that are open for community contributions. Check [issues](../../issues). | ||
|
||
## Submitting a pull request | ||
|
||
Please read our [code of conduct](CODE-OF-CONDUCT.md) and [license](LICENSE). | ||
|
||
### Create a fork | ||
[Fork](../../fork) the repository to your GitHub organization. This means that you'll have a copy of the repository under your-username/repository-name. | ||
|
||
1. Go to the repository page. | ||
2. Click the "Fork" button in the top-right corner of the page. | ||
3. Follow the instructions to create a fork of the repository in your own GitHub account. | ||
|
||
### Clone the forked repository | ||
|
||
```bash | ||
git clone https://github.com/<your-username>/<repository-name> | ||
``` | ||
Replace your-username and repository-name with your GitHub username and the name of the forked repository. | ||
|
||
### Create a new branch | ||
Create a new branch based on `main` for your changes. | ||
|
||
```bash | ||
git checkout -b <my-branch-name> main | ||
``` | ||
|
||
### Make your changes | ||
Make your changes with bug fix or new feature. | ||
|
||
### Commit your changes | ||
Use the [DCO](http://developercertificate.org/). You can attest to the DCO by commiting with the **-s** or **--signoff** options or manually adding the "Signed-off-by": | ||
```bash | ||
git add . | ||
git commit -s -m "<type>: <subject>" | ||
``` | ||
<add commit template> | ||
|
||
### Push your changes | ||
```bash | ||
git push -u origin <my-branch-name> | ||
``` | ||
The `-u` is shorthand for `--set-upstream`. This will set up the tracking reference so subsequent runs of `git push` or `git pull` can omit the remote and branch. | ||
|
||
### Create pull request | ||
- Go to your forked repository on GitHub. | ||
- You should see a prompt to compare and create a pull request for your recently pushed branch. Click on it. | ||
- If you don’t see the prompt, go to the “Pull requests” tab and click the “New pull request” button. | ||
- Select your branch from the “compare” dropdown. | ||
- Add a title and description for your pull request, explaining what changes you made and why. | ||
- Click “Create pull request”. | ||
- Wait for the pull request to be reviewed by a maintainer. | ||
- Make changes to the pull request if the reviewing maintainer recommends them. | ||
|
||
Celebrate your success after your pull request is merged. | ||
|
||
|
||
Here are a few things you can do that will increase the likelihood of your pull request to be accepted: | ||
|
||
- Follow the existing style where possible. **[Code style and language versions](https://docs.ros.org/en/jazzy/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html)** | ||
- Write tests. | ||
- Keep your change as focused as possible. | ||
If you want to make multiple independent changes, please consider submitting them as separate pull requests. | ||
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
- It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters