CONTRIBUTING.md

Contributing Guidelines

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

Branch Naming Convention

We follow a structured branch naming convention:

• feat/ - for new features
  • Example: feat/add-data-validation
• bug/ - for bug fixes
  • Example: bug/fix-parsing-error
• docs/ - for documentation updates
  • Example: docs/update-api-guide
• refactor/ - for code refactoring
  • Example: refactor/optimize-processing
• test/ - for adding or updating tests
  • Example: test/add-unit-tests

Development Process

1. Fork the repo and create your branch from main
2. Name your branch following the convention above
3. If you've added code that should be tested, add tests
4. Ensure the test suite passes
5. Make sure your code follows the existing style
6. Issue that pull request!

Pull Request Process

1. Create a Pull Request with a clear title and description
2. Link any relevant issues using GitHub keywords (fixes #123, closes #456, etc.)
3. Update the README.md with details of changes if applicable
4. The PR will be merged once you have the sign-off of at least one maintainer

Any Questions?

Don't hesitate to create an issue to ask a question or discuss something!

License

By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE file in the root directory).