diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cc69e6e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,91 @@ + + +# Contributing to Open Data Hub + +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. + +## Ways to Contribute + +You can contribute in several ways: + +- Reporting bugs +- Suggesting new features +- Improving documentation +- Submitting code changes +- Reviewing pull requests + +--- + +## Reporting Bugs + +Before creating a bug report: + +- Check existing issues to avoid duplicates +- Use the Bug Report issue template +- Provide as much detail as possible + +Include: + +- Clear description of the problem +- Steps to reproduce +- Expected vs actual behavior +- Environment details + +--- + +## Suggesting Features + +We welcome feature suggestions. + +Please use the Feature Request issue template and include: + +- Problem or use case +- Proposed solution +- Alternatives considered + +--- + +## Development Workflow + +1. Create a branch for your changes + +Example branch names: + +feature/add-new-feature +fix/fix-bug +docs/update-documentation + +2. Make your changes + +3. Commit your changes with clear messages + +4. Push your branch and open a Pull Request + +--- + +## Pull Request Guidelines + +Please ensure: + +- Changes are clear and focused +- Commit messages are descriptive +- Related issues are referenced if applicable + +Example: + +Fixes #123 + +--- + +## Code Review + +All contributions will be reviewed before merging. + +Reviewers may request changes. + +--- + +Thank you for contributing to Open Data Hub!