Skip to content

Commit c44f444

Browse files
authored
Create CONTRIBUTING.md
1 parent 7615520 commit c44f444

1 file changed

Lines changed: 91 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<!--
2+
SPDX-FileCopyrightText: NOI Techpark
3+
SPDX-License-Identifier: CC0-1.0
4+
-->
5+
6+
# Contributing to Open Data Hub
7+
8+
Thank you for your interest in contributing to Open Data Hub! We welcome contributions from the community and appreciate your help in improving the project.
9+
10+
## Ways to Contribute
11+
12+
You can contribute in several ways:
13+
14+
- Reporting bugs
15+
- Suggesting new features
16+
- Improving documentation
17+
- Submitting code changes
18+
- Reviewing pull requests
19+
20+
---
21+
22+
## Reporting Bugs
23+
24+
Before creating a bug report:
25+
26+
- Check existing issues to avoid duplicates
27+
- Use the Bug Report issue template
28+
- Provide as much detail as possible
29+
30+
Include:
31+
32+
- Clear description of the problem
33+
- Steps to reproduce
34+
- Expected vs actual behavior
35+
- Environment details
36+
37+
---
38+
39+
## Suggesting Features
40+
41+
We welcome feature suggestions.
42+
43+
Please use the Feature Request issue template and include:
44+
45+
- Problem or use case
46+
- Proposed solution
47+
- Alternatives considered
48+
49+
---
50+
51+
## Development Workflow
52+
53+
1. Create a branch for your changes
54+
55+
Example branch names:
56+
57+
feature/add-new-feature
58+
fix/fix-bug
59+
docs/update-documentation
60+
61+
2. Make your changes
62+
63+
3. Commit your changes with clear messages
64+
65+
4. Push your branch and open a Pull Request
66+
67+
---
68+
69+
## Pull Request Guidelines
70+
71+
Please ensure:
72+
73+
- Changes are clear and focused
74+
- Commit messages are descriptive
75+
- Related issues are referenced if applicable
76+
77+
Example:
78+
79+
Fixes #123
80+
81+
---
82+
83+
## Code Review
84+
85+
All contributions will be reviewed before merging.
86+
87+
Reviewers may request changes.
88+
89+
---
90+
91+
Thank you for contributing to Open Data Hub!

0 commit comments

Comments
 (0)