Skip to content

Commit d6073c8

Browse files
Added issue template
1 parent bd973fd commit d6073c8

File tree

1 file changed

+38
-22
lines changed

1 file changed

+38
-22
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
Thank you for taking the time to contribute to our library🙌🏾.
2-
3-
In this section, we detail everything you need to know about contributing to this library.
4-
1+
Thank you for taking the time to contribute to our library🙌🏾. In this section, we detail everything you need to know about contributing to this library.
52

63
**[Code of Conduct](https://github.com/probot/template/blob/master/CODE_OF_CONDUCT.md)**
74

85
## **I don't want to contribute, I have a question**
9-
106
Please don't raise an issue to ask a question. You can ask questions on our [forum](http://forum.flutterwave.com) or developer [slack](https://bit.ly/34Vkzcg). We have an army of Engineers on hand to answer your questions there.
117

128
## How can I contribute?
13-
149
### Reporting a bug
1510

1611
Have you spotted a bug? Fantastic! Before raising an issue, here are some things to do:
@@ -29,14 +24,44 @@ When you report an issue, it is important to:
2924
- Did you experience the bug on test mode or live?
3025
- Do you have the recommended versions of the library dependencies?
3126

32-
<aside>
27+
> 💡 Please make use of the issue template when reporting bugs.
28+
```markdown
29+
### Description
3330

34-
💡 Please make use of the issue template when reporting bugs.
31+
<!-- Description of the issue -->
3532

36-
</aside>
33+
### Steps to Reproduce
3734

38-
### Requesting a feature
35+
1. <!-- First Step -->
36+
2. <!-- Second Step -->
37+
3. <!-- and so on… -->
38+
39+
**Expected behaviour:**
40+
41+
<!-- What you expect to happen -->
42+
43+
**Actual behaviour:**
44+
45+
<!-- What actually happens -->
46+
47+
**Reproduces how often:**
48+
49+
<!-- What percentage of the time does it reproduce? -->
3950

51+
### Configuration
52+
53+
- API Version: <!-- v2 or v3 -->
54+
- Environment: <!-- test mode or live mode -->
55+
- Browser: <!-- [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ] -->
56+
- Language: <!-- [all | Node X.X | TypeScript X.X | Python X.X | ES6/7 | ES5 | Dart | Android X.X | PHP X.X | Laravel X.X ] -->
57+
58+
### Additional Information
59+
60+
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue e.g. detailed explanation, stack traces, related issues, suggestions on how to fix, links for us to have more context like StackOverflow, Gitter, etc. -->
61+
```
62+
63+
64+
### Requesting a feature
4065
If you need an additional feature added to the library, kindly send us an email at developers@flutterwavego.com. Be sure to include the following in your request:
4166

4267
1. A clear title that helps us to identify the requested feature.
@@ -45,19 +70,15 @@ If you need an additional feature added to the library, kindly send us an email
4570
4. Library name and version.
4671

4772
### Submitting changes (PR)
48-
4973
Generally, you can make any of the following changes to the library:
5074

5175
1. Bug fixes
5276
2. Performance improvement
5377
3. Documentation update
5478
4. Functionality change (usually new features)
5579

56-
<aside>
57-
58-
💡 Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the library will generally not be accepted.
80+
> 💡 Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the library will generally not be accepted.
5981
60-
</aside>
6182

6283
Follow these steps when making a pull request to the library:
6384

@@ -78,14 +99,9 @@ $ git commit -m "A brief summary of the commit
7899
> A paragraph describing what changed and its impact."
79100
```
80101

81-
<aside>
82-
83-
💡 For your pull request to be reviewed, you need to meet the requirements above. We may ask you to complete additional tests, or other changes before your pull request can be ultimately accepted.
84-
85-
</aside>
102+
> 💡 For your pull request to be reviewed, you need to meet the requirements above. We may ask you to include additional tests, or changes before your pull request can be ultimately accepted.
86103
87104
We encourage you to contribute and help make the library better for the community. Got questions? send us a [message](https://bit.ly/34Vkzcg).
88105

89106
Thank you.
90-
91-
The Flutterwave team 🦋
107+
The Flutterwave team 🦋

0 commit comments

Comments
 (0)