Skip to content

Commit 58dde11

Browse files
daquinoaldodaquinoaldo
committed
Update contributing guidelines
1 parent 1ea95f4 commit 58dde11

4 files changed

Lines changed: 31 additions & 27 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ I'll be very heppy to help you!
1616
- Please try to keep the test coverage at 100%. Write additional unit test if necessary.
1717
- Please create an issue before sending a pull request and reference the issue from the pull request.
1818
- Feel free to ask for help. If you having troubles in soddisfing this requirements I'll be happy to help you!
19+
20+
**Do not let yourself be stopped by schemes or formalities!**
21+
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.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,16 @@ A clear and concise description of what the bug is.
99

1010
**To Reproduce**
1111
Steps to reproduce the behavior:
12-
1. Go to '...'
13-
2. Click on '....'
14-
3. Scroll down to '....'
15-
4. See error
12+
1. Run with command...
13+
2. Pass as parameter...
14+
3. ...
1615

1716
**Expected behavior**
1817
A clear and concise description of what you expected to happen.
1918

2019
**System information (please complete the following information):**
21-
- OS: [e.g. MacOS X, Windows, Ubuntu, ...]
22-
- Version [e.g. 1.1.2]
20+
- OS: [e.g. MacOS X Mojave, Ubuntu 18.04, Windows 10 build XXX, ...]
21+
- App version [e.g. 1.1.2]
2322

2423
**Additional context**
2524
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ about: Suggest an idea for this project
44

55
---
66

7-
**Is your feature request related to a problem? Please describe.**
7+
**Is your feature request related to a problem?**
88
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
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.
12+
1013
**Describe the solution you'd like**
1114
A clear and concise description of what you want to happen.
1215

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,39 @@
1-
# PR Details
1+
<!-- PREMISE: I would really appreciate if you could follow this scheme as much as possible. -->
2+
<!-- Anyway, I believe in open source software and I really appreciate those who decide to work on a project that appreciates. -->
3+
<!-- If this scheme puts you in trouble, feel free to follow it only partially or not to follow it at all. -->
4+
<!-- 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. -->
25

3-
<!--- Provide a general summary of your changes in the Title above -->
6+
# PR Details
7+
<!-- Provide a general summary of your changes in the Title above -->
48

59
## Description
6-
7-
<!--- Describe your changes in detail -->
10+
<!-- Describe your changes in detail -->
811

912
## Related Issue
10-
11-
<!--- This project only accepts pull requests related to open issues -->
12-
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
13-
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
14-
<!--- Please link to the issue here: -->
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: -->
1517

1618
## Motivation and Context
17-
18-
<!--- Why is this change required? What problem does it solve? -->
19+
<!-- Why is this change required? What problem does it solve? -->
1920

2021
## How Has This Been Tested
21-
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. -->
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. -->
2525

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

3029
- [ ] Docs change / refactoring / dependency upgrade
3130
- [ ] Bug fix (non-breaking change which fixes an issue)
3231
- [ ] New feature (non-breaking change which adds functionality)
3332
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
3433

3534
## Checklist
36-
37-
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
38-
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
35+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
36+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
3937

4038
- [ ] My code follows the code style of this project.
4139
- [ ] My change requires a change to the documentation.

0 commit comments

Comments
 (0)