mirror of
https://github.com/dstotijn/hetty
synced 2024-11-13 23:47:09 +00:00
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
|
# 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._
|