mirror of
https://github.com/BetterSEQTA/BetterSEQTA-Plus.git
synced 2026-06-06 03:34:40 +00:00
Andrew R
40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# Contributing
|
||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||
email, or any other method with the owners of this repository before making a change.
|
||
|
||
## Pull Request Process
|
||
|
||
1. It is recommended to start by opening an issue to discuss the change you wish to make. This will allow us to discuss the change and ensure it is a good fit for the project.
|
||
2. Fork the repo and create your branch from `master`.
|
||
3. When writing your pull request, make sure to use the pull request template.
|
||
|
||
### Pull Request Template
|
||
|
||
```
|
||
## Description
|
||
|
||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||
|
||
Fixes # (issue)
|
||
|
||
## 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
|
||
```
|
||
|
||
### Issues
|
||
|
||
#### Create a new issue
|
||
|
||
If you spot a problem with the readme or code, [search if an issue already exists](https://github.com/BetterSEQTA/BetterSEQTA-Plus/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/BetterSEQTA/BetterSEQTA-Plus/issues/new).
|
||
|
||
#### Solve an issue
|
||
|
||
Scan through our [existing issues](https://github.com/BetterSEQTA/BetterSEQTA-Plus/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
|