Add initial issue template and CONTRIBUTING.md

This commit is contained in:
henil 2021-01-25 23:06:24 +05:30
parent 63a2dc3399
commit aa8da0b142
4 changed files with 42 additions and 0 deletions

4
.github/ISSUE_TEMPLATE/blank_issue.md vendored Normal file
View file

@ -0,0 +1,4 @@
---
name: Blank Issue
about: Create a blank issue.
---

5
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,5 @@
---
name: Bug Report
about: Create a bug report
labels: bug
---

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1 @@
blank_issues_enabled: true

32
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,32 @@
# Contributing to Mosaic
Thanks for considering to contribute to mosaic!
Before contributing please read our [Code of Conduct](CODE_OF_CONDUCT.md) which
all contributors are expected to adhere to.
## Add an entry to the changelog
If your contribution changes the behavior of `mosaic` (as opposed to a typo-fix
in the documentation), please update the [`CHANGELOG.md`](CHANGELOG.md) file
and describe your changes. This makes the release process much easier and
therefore helps to get your changes into a new `mosaic` release faster.
The top of the `CHANGELOG` contains a *"unreleased"* section with a few
subsections (Features, Bugfixes, …). Please add your entry to the subsection
that best describes your change.
Entries follow this format:
```
- Short description of what has been changed, see #123 (@user)
```
Here, `#123` is the number of the original issue and/or your pull request.
Please replace `@user` by your GitHub username.
## Lacking API for plugin in mosaic
If you have a plugin idea, but mosaic still doesn't have API required to make
the plugin consider opening [an issue][plugin-issue] and describing your
requirements.
[plugin-issue]: https://github.com/mosaic-org/mosaic/issues/new?assignees=&labels=plugin%20system