Contribution Guidelines

Thank you for considering contributing to our project! This document outlines the process for making contributions.

Getting Started

1. Clone the repository locally
2. Create a new branch from develop using the following naming convention:

   feature/<feature-name>
   

   For example: feature/add-data-validation
3. Set up your development environment

Development Process

1. Make your changes in your feature branch
2. Write tests for any new functionality
3. Update documentation as needed
4. Ensure your code follows our coding standards
5. Run the test suite locally to verify everything works

Pull Request Process

1. Create a Pull Request (PR) targeting the develop branch

2. Complete the PR template thoroughly, including:

   • Description of changes
   • Testing performed
   • Documentation updates
   • Breaking changes (if any)

3. Ensure the CI/CD pipeline passes, which includes:

   • Code style checks
   • Unit tests
   • Documentation builds

4. Address any review comments promptly

Requirements for Merge

• ✅ CI/CD pipeline must pass
• ✅ Tests must be written for new functionality
• ✅ Documentation must be updated
• ✅ PR template must be completed
• ✅ At least two approvals from maintainers

After Merge

Once your PR is approved and merged into develop:

• Your changes will be included in the next release
• The feature branch can be deleted
• The corresponding issue will be closed

Need Help?

If you need assistance at any point:

• Check existing issues and documentation
• Create a new issue with questions
• Reach out to maintainers

Thank you for contributing to our project! 🎉