diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..f19cdd25 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing to Wiki.js + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +## Reporting issues + +A default template is provided when creating a new GitHub issue. Please use it and share as much info as possible on your system (OS, Browser and Node.js versions, etc.), how to reproduce the bug, the expected result, etc. + +## Requesting new features / enhancements + +Use the feature request board to submit new ideas and vote on which ideas should be integrated first. + +:triangular_flag_on_post: [https://wikijs.canny.io/features](https://wikijs.canny.io/features) + +*Do not use GitHub issues to submit new feature ideas, as it will closed and you'll be asked to use the feature request board above. GitHub Issues are limited to bugs / issues / help*. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..48b4ba18 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,7 @@ +### Actual behavior + +### Expected behavior + +### Steps to reproduce the behavior + +[FOR NEW FEATURE REQUESTS]: # (Use the feature/idea board instead: https://wikijs.canny.io/features) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md index 7487b426..e9019a35 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ - [Documentation](#documentation) - [Requirements](#requirements) - [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) +- [Feature Requests](https://wikijs.canny.io/features) - [Project Planning](https://waffle.io/Requarks/wiki) - [Milestones](#milestones) - [Chat with us](#gitter)