From 49792e1cc11603d6ab13a96da4e0f2fd61ac9804 Mon Sep 17 00:00:00 2001 From: Aldo D'Aquino Date: Tue, 23 Apr 2019 14:55:44 +0200 Subject: [PATCH] Simplify contributing guidelines --- .github/CONTRIBUTING.md | 5 ++--- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++---------- .github/PULL_REQUEST_TEMPLATE.md | 25 ++++------------------- 4 files changed, 14 insertions(+), 38 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a214e3b..0d8e8f1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,11 +12,10 @@ I'll be very heppy to help you! 5. Perform a pull request for each proposed change ## Guidelines -- Please try to [combine multiple commits before pushing](http://stackoverflow.com/questions/6934752/combining-multiple-commits-before-pushing-in-git) - Please try to keep the test coverage at 100%. Write additional unit test if necessary. -- Please create an issue before sending a pull request and reference the issue from the pull request. +- Please create an issue before sending a pull request and reference the issue from the pull request. This helps in understanding better the PR aim. - Feel free to ask for help. If you having troubles in soddisfing this requirements I'll be happy to help you! **Do not let yourself be stopped by schemes or formalities!** Your contribution, big or small, is always welcome! -If you can contribute, but you can not follow these patterns it's all right, it will only take a little more time to take charge of your suggestions. +If you can contribute, but you can not follow these patterns it's all right, we will do it togeter. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e87f73d..0538e29 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,8 +4,8 @@ about: Create a report to help us improve --- -**Describe the bug** -A clear and concise description of what the bug is. +**Bug description** +A concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5ec0ed8..0f9f8d5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,17 +4,11 @@ about: Suggest an idea for this project --- -**Is your feature request related to a problem?** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**How would you like to expand the functionalities?** +A description of what the new feature aim should be. -**or you would like to expand the functionalities with...** -A clear and concise description of what the new feature aim should be. +**Are there alternatives?** +Workaround, etc... -**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. +**Is it a breaking change?** +It changes how the users interact with this tool? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5269a81..823aa1d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,29 +3,13 @@ -# PR Details - - -## Description - +# Pull Request Details ## Related Issue - - - - - -## Motivation and Context - - -## How Has This Been Tested - - - +Please, open a issue before a pull request. It will help in understanding better the PR aim. ## Types of changes - - + - [ ] Docs change / refactoring / dependency upgrade - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) @@ -34,10 +18,9 @@ ## Checklist - - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) document. -- [ ] I have added tests to cover my changes. +- [ ] I have added tests to cover my changes (or the exist one were enough). - [ ] All new and existing tests passed.