Skip to content

Commit 9b445a4

Browse files
authored
Create CONTRIBUTING.md
1 parent 573ced9 commit 9b445a4

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
# How To Contribute
3+
4+
Community made patches, bug reports and contributions are always welcome for Paystack plugins and libraries.
5+
6+
When contributing please ensure you follow the guidelines below to help us keep on top of things.
7+
8+
__Please Note:__
9+
10+
GitHub is for _bug reports and contributions only_ - if you have a support question or a request for a customization this is not the right place to post it. Please reach out by
11+
12+
- sending a message from [our website](https://paystack.com/contact).
13+
- posting a question on the plugin support forum.
14+
15+
## Contributing to Plugin
16+
17+
### Reporting Issues
18+
19+
Reporting issues is a great way to became a contributor as it doesn't require technical skills. In fact you don't even need to know a programming language or to be able to check the code itself, you just need to make sure that everything works as expected and [submit an issue report](https://github.com/PaystackHQ/plugin-prestashop-1.6/issues/new) if you spot a bug. Sound like something you're up for? Go for it!
20+
21+
#### How To Submit An Issue Report
22+
23+
If something isn't working, congratulations you've found a bug! Help us fix it by submitting an issue report:
24+
25+
* Make sure you have a [GitHub account](https://github.com/signup/free)
26+
* Search the [Existing Issues](https://github.com/PaystackHQ/plugin-prestashop-1.6/issues) to be sure that the one you've noticed isn't already there
27+
* Submit a report for your issue
28+
* Clearly describe the issue (including steps to reproduce it if it's a bug)
29+
* Make sure you fill in the earliest version that you know has the issue.
30+
31+
### Making Changes
32+
33+
If you believe you have an improvement to the plugin, please feel free to send a pull request so we can review and merge.
34+
35+
#### How To Submit A PR
36+
37+
* Fork the repository on GitHub
38+
* Clone the repository into your local system and create a branch that describes what you are working on by prefixing with `feature/`, `fix/`, `chore/`and so on followed by the title of the fix or feature.
39+
* Make commits that are descriptive and breaks down the process.
40+
* Please **don't** modify the changelog - this will be maintained by Paystack developers.
41+
* Push your fix to the remote version of your branch and create a PR that aims to merge that branch into `master`.
42+
43+
After you follow the step above, the next stage will be waiting on us to merge your Pull Request. We review them all, and make suggestions and changes as and if necessary.
44+
45+
# Additional Resources
46+
47+
* [General GitHub documentation](https://help.github.com/)
48+
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
49+
* [Paystack Documentation](https://developers.paystack.co/v2.0/docs/)
50+
* [Paystack Helpdesk](https://paystack.com/help)

0 commit comments

Comments
 (0)