Thank you for your interest in contributing to Schema Evolution Analyzer! We welcome contributions from the community to help improve and enhance the project.
To get started with contributing, follow these steps:
- Fork the repository on GitHub.
- Clone your forked repository locally.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive messages.
- Push your changes to your forked repository.
- Open a pull request against the main repository.
To set up the development environment, follow these steps:
- Ensure you have Python 3.9 or higher installed.
- Create a virtual environment:
python -m venv venv. - Activate the virtual environment:
source venv/bin/activate. - Install the development dependencies:
pip install -r requirements.txt. - Run the tests to ensure everything is set up correctly:
make test.
We follow the PEP 8 style guide for Python code. Please ensure your code adheres to these guidelines. You can use tools like flake8 and black to check and format your code.
We use pytest for running tests. Please ensure that your changes are covered by appropriate tests. You can run the test suite using make test.
If your changes introduce new features or modify existing ones, please update the documentation accordingly. We use Markdown for documentation files.
If you find a bug or have a feature request, please open an issue on the GitHub repository. Provide as much detail as possible to help us understand and reproduce the issue.
If you have any questions or need further assistance, feel free to reach out to the maintainers:
- Goku ([email protected])
Thank you for your contributions!