Skip to content

Commit 49792e1

Browse files
committed
Simplify contributing guidelines
1 parent ea32bac commit 49792e1

File tree

4 files changed

+14
-38
lines changed

4 files changed

+14
-38
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ I'll be very heppy to help you!
1212
5. Perform a pull request for each proposed change
1313

1414
## Guidelines
15-
- Please try to [combine multiple commits before pushing](http://stackoverflow.com/questions/6934752/combining-multiple-commits-before-pushing-in-git)
1615
- Please try to keep the test coverage at 100%. Write additional unit test if necessary.
17-
- Please create an issue before sending a pull request and reference the issue from the pull request.
16+
- 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.
1817
- Feel free to ask for help. If you having troubles in soddisfing this requirements I'll be happy to help you!
1918

2019
**Do not let yourself be stopped by schemes or formalities!**
2120
Your contribution, big or small, is always welcome!
22-
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.
21+
If you can contribute, but you can not follow these patterns it's all right, we will do it togeter.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ about: Create a report to help us improve
44

55
---
66

7-
**Describe the bug**
8-
A clear and concise description of what the bug is.
7+
**Bug description**
8+
A concise description of what the bug is.
99

1010
**To Reproduce**
1111
Steps to reproduce the behavior:

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,11 @@ about: Suggest an idea for this project
44

55
---
66

7-
**Is your feature request related to a problem?**
8-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
7+
**How would you like to expand the functionalities?**
8+
A description of what the new feature aim should be.
99

10-
**or you would like to expand the functionalities with...**
11-
A clear and concise description of what the new feature aim should be.
10+
**Are there alternatives?**
11+
Workaround, etc...
1212

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
15-
16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
18-
19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
13+
**Is it a breaking change?**
14+
It changes how the users interact with this tool?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,13 @@
33
<!-- If this scheme puts you in trouble, feel free to follow it only partially or not to follow it at all. -->
44
<!-- 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. -->
55

6-
# PR Details
7-
<!-- Provide a general summary of your changes in the Title above -->
8-
9-
## Description
10-
<!-- Describe your changes in detail -->
6+
# Pull Request Details
117

128
## Related Issue
13-
<!-- This project only accepts pull requests related to open issues -->
14-
<!-- If suggesting a new feature or change, please discuss it in an issue first -->
15-
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
16-
<!-- Please link to the issue here: -->
17-
18-
## Motivation and Context
19-
<!-- Why is this change required? What problem does it solve? -->
20-
21-
## How Has This Been Tested
22-
<!-- Please describe in detail how you tested your changes. -->
23-
<!-- Include details of your testing environment, and the tests you ran to -->
24-
<!-- see how your change affects other areas of the code, etc. -->
9+
Please, open a issue before a pull request. It will help in understanding better the PR aim.
2510

2611
## Types of changes
27-
<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
28-
12+
<!-- Put an `x` in all the boxes that apply -->
2913
- [ ] Docs change / refactoring / dependency upgrade
3014
- [ ] Bug fix (non-breaking change which fixes an issue)
3115
- [ ] New feature (non-breaking change which adds functionality)
@@ -34,10 +18,9 @@
3418
## Checklist
3519
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
3620
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
37-
3821
- [ ] My code follows the code style of this project.
3922
- [ ] My change requires a change to the documentation.
4023
- [ ] I have updated the documentation accordingly.
4124
- [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) document.
42-
- [ ] I have added tests to cover my changes.
25+
- [ ] I have added tests to cover my changes (or the exist one were enough).
4326
- [ ] All new and existing tests passed.

0 commit comments

Comments
 (0)