forked from aosp-mirror/platform_external_sonivox
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from pedrolcl/contribution-guidelines
add templates and guidelines
- Loading branch information
Showing
4 changed files
with
106 additions
and
0 deletions.
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,42 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
<!-- DO NOT SUBMIT SUPPORT REQUESTS OR "HOW TO" QUESTIONS HERE! | ||
If you have a question, start a GitHub Discussion: | ||
https://github.com/pedrolcl/sonivox/discussions | ||
Below is a form that shall help getting relevant information for bugs together. | ||
Feel free to edit or remove inapplicable/unneeded parts. | ||
--> | ||
|
||
### Sonivox version | ||
You may run `example/sonivoxrender` on your build directory to output the version numbers: | ||
|
||
```bash | ||
$ example/sonivoxrender --version | ||
version: 3.6.15.0 | ||
``` | ||
|
||
### Describe the bug | ||
A clear and concise description of what the bug is, including error messages and debugger output. | ||
If the bug is a program crash, please provide a back trace running the program on the debugger. | ||
|
||
### Steps to reproduce the wrong behavior: | ||
1. | ||
2. | ||
3... | ||
|
||
### Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
#### Screenshots | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
#### Additional context | ||
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,24 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
--- | ||
|
||
<!-- DO NOT SUBMIT SUPPORT REQUESTS OR "HOW TO" QUESTIONS HERE! | ||
If you have a question, start a GitHub Discussion: | ||
https://github.com/pedrolcl/sonivox/discussions | ||
Below is a form that shall help getting relevant information for features together. | ||
Feel free to edit or remove inapplicable/unneeded parts. | ||
--> | ||
|
||
### Describe the feature | ||
|
||
A clear and concise description of what the feature is and why it would be useful. | ||
|
||
#### Additional context | ||
|
||
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,14 @@ | ||
## Description | ||
|
||
Please describe the changes you've made. | ||
|
||
## Related Issues | ||
|
||
[Link to any related issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue) here, for instance using the verbs `Fix` or `Close` | ||
|
||
## Checklist | ||
|
||
- [ ] I have followed the contribution guidelines. | ||
- [ ] My code follows the coding standards. | ||
- [ ] I have tested my changes. | ||
|
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,26 @@ | ||
# Contributing to Sonivox | ||
|
||
Thank you for considering contributing to Sonivox! | ||
|
||
## Workflow | ||
|
||
We do not allow merge requests into the `master` branch directly. Please follow these steps: | ||
|
||
1. Fork (and clone) the repository. | ||
2. Create a new branch from `devel` for your changes. | ||
3. Open an issue describing the contributions you plan to make. | ||
4. Make your changes and commit them with clear commit messages. | ||
5. Open a pull request to merge your changes into the `devel` branch. | ||
|
||
## Coding Standards | ||
|
||
- Follow the existing coding style. | ||
- Write clear and concise commit messages. | ||
- Ensure your code passes all tests. | ||
|
||
## Pull Requests | ||
|
||
When opening a pull request, please: | ||
- Describe the changes you've made. | ||
- Link to the issue describing your contributions. | ||
- Ensure your code follows the contribution guidelines. |