diff options
| author | henil <dedaniahenil@gmail.com> | 2021-01-25 23:06:24 +0530 |
|---|---|---|
| committer | henil <dedaniahenil@gmail.com> | 2021-01-31 12:12:55 +0530 |
| commit | aa8da0b14232ca20ff6438bbd2ba9477888e1db1 (patch) | |
| tree | 08c679b8053d525fc100a80718858061d6a00e67 | |
| parent | 63a2dc33995fad81c7eec02b23e38afdc3f426e8 (diff) | |
Add initial issue template and CONTRIBUTING.md
| -rw-r--r-- | .github/ISSUE_TEMPLATE/blank_issue.md | 4 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 5 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 1 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 32 |
4 files changed, 42 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md new file mode 100644 index 000000000..9aef3ebe6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank_issue.md @@ -0,0 +1,4 @@ +--- +name: Blank Issue +about: Create a blank issue. +--- diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..5e6553c91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,5 @@ +--- +name: Bug Report +about: Create a bug report +labels: bug +--- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0086358db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..fa19fd199 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 |