547e079514
The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown.
13 lines
677 B
Markdown
13 lines
677 B
Markdown
# Contributing Guidelines
|
|
|
|
Contributing entails that all contributions follow the [MPL 2.0 license](https://github.com/buffet/kiwmi/blob/master/LICENSE).
|
|
|
|
## Opening Issues
|
|
|
|
- Ensure that bugs have proper steps to reproduce
|
|
- Include program version, along with any system specs that may help identify the issue
|
|
|
|
## Committing
|
|
|
|
Commit messages should be both _clear_ and _descriptive_. If possible, commit titles should start with a verb describing the change. Don't be shy to include additional information such as motivation for the change in the commit body. Be sure to ensure other developers will be able to understand _why_ a specific change has occurred in the future.
|
|
|