Merge pull request #4837 from Trifoia/4803-Add-a-CONTRIBUTING.md
4803 add a contributing.md
This commit is contained in:
commit
8c430ce1a6
24
CONTRIBUTING.md
Normal file
24
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Contributing to Oqtane
|
||||
|
||||
## How to Contribute
|
||||
|
||||
We track all of our issues on Github. If you want to contribute, everything starts with an issue. If you don't have an issue yet, you can add one. Then a core contributor will tag it as either an enhancement [ENH] or a bug [BUG]. Tagged issues are open for contribution.
|
||||
|
||||
## Use GitHub-flow process
|
||||
- Make a comment on the issue that you intend to work on it and read all the comments to gain a full understanding.
|
||||
- Fork the repository
|
||||
- Create a new branch and update your comment on the issue with a llink to the branch
|
||||
- Make your changes and commit them
|
||||
- Push to the branch
|
||||
- Create a pull request
|
||||
|
||||
## Reporting Bugs
|
||||
|
||||
- Check if the issue has already been reported.
|
||||
- Open a new issue if it hasn’t been reported.
|
||||
|
||||
## Requesting Features
|
||||
|
||||
- Use the feature request template in the Issues tab.
|
||||
|
||||
Thank you for contributing!
|
Loading…
Reference in New Issue
Block a user