Skip to content

Commit 6030570

Browse files
Contributing guide lines.
1 parent 1704508 commit 6030570

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Helping hands are always welcome to contribute with bug fixes and enhancements to UniCache. Feel free to report issues
4+
which you observe while integrating UniCache in your project.
5+
6+
## How to Report Issues
7+
To report an issue, please use the [Github issues tracker](https://github.com/PLG-Works/UniCache/issues). When reporting issues,
8+
please mention the following details, whichever applicable:
9+
- Steps to reproduce with sample snippets.
10+
- Actual vs. expected behaviour.
11+
- Whether it is a bug or proposed enhancement.
12+
- Release version which the issue is concerned with.
13+
14+
## Workflow for Pull Requests
15+
In order to contribute, please fork off the particular release-{version} branch and make your changes there. Your commit
16+
messages should detail why you made your change in addition to what you did (unless it is a tiny change).
17+
18+
If you are enhancing with a new feature, please ensure to add appropriate test cases under `test/` folder. It's also a
19+
good practice to add new test cases in case of bug fixes too.
20+
21+
If you are taking up a big change, please add an issue and discuss with the UniCache team first to get opinions from
22+
multiple developers.
23+
24+
Finally, please respect the coding style of this project. And of course, please test your code thoroughly before raising PR.
25+
26+
Thank you for your help!
27+
28+

0 commit comments

Comments
 (0)