From 7d3f41d21cbfcc0a3675fa40ec80f6661498b711 Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Mon, 22 Jul 2024 14:13:16 -0400 Subject: [PATCH] [docs] Added Issue Template, PR Template, updated CONTRIBUTING [skip ci] --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 12 +++++++++ .github/pull_request_template.md | 20 +++++++++++++++ CONTRIBUTING.rst | 5 +--- 5 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..19e1875c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Open a bug report +title: "[bug] " +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of the bug or unexpected behavior. + +**Steps To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**System Informatioon:** + - OS: [e.g. Ubuntu 24.04 LTS] + - Python Version: [e.g. Python 3.11.2] + - Django Version: [e.g. Django 4.2.5] + - Browser and Browser Version (if applicable): [e.g. Chromium v126.0.6478.126] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..523386b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[feature] " +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..34a8295a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,12 @@ +--- +name: Question +about: Please use the Discussion Forum to ask questions +title: "[question] " +labels: question +assignees: '' + +--- + +Please use the [Discussion Forum](https://github.com/orgs/openwisp/discussions) to ask questions. + +We will take care of moving the discussion to a more relevant repository if needed. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..49f70938 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Checklist + +- [ ] I have read the [OpenWISP Contributing Guidelines](http://openwisp.io/docs/developer/contributing.html). +- [ ] I have manually tested the changes proposed in this pull request. +- [ ] I have written new test cases for new code and/or updated existing tests for changes to existing code. +- [ ] I have updated the documentation. + +## Reference to Existing Issue + +Closes #. + +Please [open a new issue](https://github.com/openwisp/openwisp-radius/issues/new/choose) if there isn't an existing issue yet. + +## Description of Changes + +Please describe these changes. + +## Screenshot + +Please include any relevant screenshots. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a4cc51a5..82049609 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,4 +1 @@ -Contributing -============ - -Please read the Contributing section in the README of this project. +Please refer to the `OpenWISP Contribution Guidelines `_.