Skip to content

Commit 44fa923

Browse files
update community contribution guidelines
1 parent c8aa1b7 commit 44fa923

File tree

1 file changed

+63
-30
lines changed

1 file changed

+63
-30
lines changed

CONTRIBUTION.md

Lines changed: 63 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,84 @@
1-
##Contribution and Development Docs
1+
# Community contribution guide
22

3-
This guide contains steps on how to setup, contribute, build and publish to the Flutterwave Vue package.
3+
Thank you for taking the time to contribute to our library🙌🏾.
44

5-
The library is generated using 'vue-sfc-rollup' package . This package creates a set of files for building Vue libraries to simplify the build and deployment process.
5+
In this section, we detail everything you need to know about contributing to this library.
66

7-
###Get started
7+
88

9-
* Install the 'vue-sfc-rollup' package.
9+
**[Code of Conduct](https://github.com/probot/template/blob/master/CODE_OF_CONDUCT.md)**
1010

11-
````ignorelang
12-
npm install -g vue-sfc-rollup
13-
````
11+
## **I don't want to contribute, I have a question**
1412

15-
* Pull down project from github.
13+
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.
1614

17-
* Run 'npm install' in project root folder
18-
```ignorelang
19-
npm install
20-
```
15+
## How can I contribute?
2116

22-
###File Structure
23-
The library code files are located in './src' folder
17+
### Reporting a bug
2418

19+
Have you spotted a bug? Fantastic! Before raising an issue, here are some things to do:
2520

26-
###Code Contribution
27-
Please follow the guidelines below when adding features, components, etc to the library.
21+
1. Search to see if another user has reported the bug. For existing issues that are still open, add a comment instead of creating a new one.
22+
2. Check our forum and developer slack to confirm that we did not address it there.
2823

29-
* Library files should be in the './src' folder
24+
When you report an issue, it is important to:
3025

31-
* Components should be created in the './src/lib-components' folder
26+
1. Explain the problem
27+
- Use a clear and descriptive title to help us to identify the problem.
28+
- Describe steps we can use to replicate the bug and be as precise as possible.
29+
- Include screenshots of the error messages.
30+
2. Include details about your configuration and setup
31+
- What version of the library are you using?
32+
- Did you experience the bug on test mode or live?
33+
- Do you have the recommended versions of the library dependencies?
3234

33-
* All components in the 'src/lib-components' folder should be exported in the 'src/lib-components/index.js'
34-
file
3535

36-
* Components are tested in the dev folder.
36+
> 💡 Please make use of the issue template when reporting bugs.
3737
3838

39-
###Build And Publish
39+
### Requesting a feature
4040

41-
To build, run :
41+
If you need an additional feature added to the library, kindly send us an email at [email protected]. Be sure to include the following in your request:
4242

43-
```ignorelang
44-
npm run build
45-
```
43+
1. A clear title that helps us to identify the requested feature.
44+
2. A brief description of the use case for that feature.
45+
3. Explain how this feature would be helpful to your integration.
46+
4. Library name and version.
47+
48+
### Submitting changes (PR)
49+
50+
Generally, you can make any of the following changes to the library:
51+
52+
1. Bug fixes
53+
2. Performance improvement
54+
3. Documentation update
55+
4. Functionality change (usually new features)
56+
57+
> 💡 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.
4658
47-
To publish, run
59+
Follow these steps when making a pull request to the library:
4860

49-
```ignorelang
50-
npm publish
61+
1. Fork the repository and create your branch from master.
62+
2. For all types of changes (excluding documentation updates), add tests for the changes.
63+
3. If you are making a functionality change, update the docs to show how to use the new feature.
64+
4. Ensure all your tests pass.
65+
5. Make sure your code lints.
66+
6. Write clear log messages for your commits. one-liners are fine for small changes, but bigger changes should have a more descriptive commit message (see sample below).
67+
7. Use present tense for commit messages, "Add feature" not "Added feature”.
68+
8. Ensure that you fill out all sections of the PR template.
69+
9. Raise the PR against the `dev` branch.
70+
10. After you submit the PR, verify that all [status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) are passing
71+
72+
```markdown
73+
$ git commit -m "A brief summary of the commit
74+
>
75+
> A paragraph describing what changed and its impact."
5176
```
77+
78+
> 💡 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.
79+
80+
We encourage you to contribute and help make the library better for the community. Got questions? send us a [message](https://bit.ly/34Vkzcg).
81+
82+
Thank you.
83+
84+
The Flutterwave team 🦋

0 commit comments

Comments
 (0)