Mirrors/hetty
2
0
Fork 0
mirror of https://github.com/dstotijn/hetty synced 2024-11-22 03:33:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add contributing guidelines

Browse source
This commit is contained in:
David Stotijn 2020-10-04 13:21:08 +02:00
parent 248001ec8a
commit 6fad74c0a5
2 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,35 @@
# Contribution Guidelines
Thank you for taking an interest in Hetty! If you want to contribute to the
project, please read the guidelines below to ensure a smooth develop experience.
## Code of conduct
Please first read the [code of conduct](CODE_OF_CONDUCT.md), and abide to it
whenever you interact with the community.
## Issues
Use [issues](https://github.com/dstotijn/hetty/issues) for reporting bugs,
adding feature requests and giving context to PRs you submit. Please use [labels](https://github.com/dstotijn/hetty/labels)
in favor of category prefixes in issue titles. To keep the issue tracker
focused on development, use [discussions](https://github.com/dstotijn/hetty/discussions)
for usage questions and non-code related discourse.
Before submitting new feature requests, check out the Kanban board for the
status of on-going work. There might already be a card/issue.
## Pull requests
Before submitting a pull request that introduces a new feature or significantly
changes the behavior of Hetty, please consider first using [discussions](https://github.com/dstotijn/hetty/discussions)
or commenting on a relevant existing issue to share what you have in mind.
Because the project is in an early stage, this is especially important; there
are still a lot of major design decisions to be made. Until the foundation has
solidified, design and implementation leading up to the first milestone (v1.0)
is highly in flux, and your work might not align/be applicable for what the
maintainers have envisioned.
## Development
_Todo: Write steps for setting up local development environment._

4
README.md
View file

@ -111,6 +111,10 @@ write-up on its mission and roadmap. A short summary/braindump:
The project is currently under active development. Please star/follow and check
back soon. 🤗
## Contributing
Please see the [Contribution Guidelines](CONTRIBUTING.md) for details.
## Acknowledgements
Thanks to the [Hacker101 community on Discord](https://www.hacker101.com/discord)