Skip to content

Commit 47f507c

Browse files
authored
Create CONTRIBUTE.md
Signed-off-by: JoleVLF <jovan.glavonjic@vizlore.com>
1 parent b547d2a commit 47f507c

1 file changed

Lines changed: 73 additions & 0 deletions

File tree

CONTRIBUTE.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to Reporting Service
2+
3+
We’re excited that you’re interested in contributing to Reporting Service! 🎉
4+
This project is licensed under the EUPL v1.2 and welcomes contributors of all backgrounds and experience levels.
5+
6+
## 🚀 How to Contribute
7+
8+
### Fork & Clone
9+
10+
- Fork the repository on GitHub.
11+
12+
- Clone your fork locally:
13+
14+
git clone https://github.com/your-username/reporting-service.git
15+
cd reporting-service
16+
17+
### Create a Branch
18+
19+
Always create a new branch for your work:
20+
21+
git checkout -b feature/my-new-feature
22+
23+
### Make Your Changes
24+
25+
Add or update tests when making changes.
26+
27+
### Commit & Push
28+
29+
Write clear, descriptive commit messages:
30+
31+
git commit -m "Add support for caching pdf reports"
32+
git push origin feature/my-new-feature
33+
34+
### Open a Pull Request
35+
36+
Go to the main repo and open a PR (Pull Request).
37+
38+
Describe:
39+
40+
- What your change does
41+
42+
- Why it’s needed
43+
44+
- Any related issues
45+
46+
Maintainers will review your PR and may request changes. Don’t worry — feedback is part of the process!
47+
48+
49+
### 📝 Reporting Issues
50+
51+
Check the issue tracker first.
52+
53+
If not already reported, open a new issue with:
54+
55+
- A clear description
56+
57+
- Steps to reproduce (if a bug)
58+
59+
- Expected vs actual behavior
60+
61+
### 🌱 First-Time Contributors
62+
63+
We especially welcome first-time contributors! Some good first steps:
64+
65+
Look for issues labeled good first issue.
66+
67+
Improve documentation (typos, examples, guides).
68+
69+
Add tests for untested parts of the code.
70+
71+
### 🙏 Acknowledgments
72+
73+
Every contribution — big or small — matters. Thank you for helping improve!

0 commit comments

Comments
 (0)