Skip to content

Commit

Permalink
Simplify contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
daquinoaldo committed Apr 23, 2019
1 parent ea32bac commit 49792e1
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 38 deletions.
5 changes: 2 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 6 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
25 changes: 4 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,13 @@
<!-- If this scheme puts you in trouble, feel free to follow it only partially or not to follow it at all. -->
<!-- Your contribution will be taken to heart and welcomed with open arms in the same way, it will only need a little more work to integrate the changes. -->

# PR Details
<!-- Provide a general summary of your changes in the Title above -->

## Description
<!-- Describe your changes in detail -->
# Pull Request Details

## Related Issue
<!-- This project only accepts pull requests related to open issues -->
<!-- If suggesting a new feature or change, please discuss it in an issue first -->
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!-- Please link to the issue here: -->

## Motivation and Context
<!-- Why is this change required? What problem does it solve? -->

## How Has This Been Tested
<!-- Please describe in detail how you tested your changes. -->
<!-- Include details of your testing environment, and the tests you ran to -->
<!-- see how your change affects other areas of the code, etc. -->
Please, open a issue before a pull request. It will help in understanding better the PR aim.

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

<!-- Put an `x` in all the boxes that apply -->
- [ ] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
Expand All @@ -34,10 +18,9 @@
## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] 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.

0 comments on commit 49792e1

Please sign in to comment.