1.3 KiB
1.3 KiB
Contributing to Code Editor
We love your input! We want to make contributing to Code Editor 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
Development Process
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
Pull Requests
- Update the README.md with details of changes if applicable
- Update the documentation with details of changes if applicable
- The PR should work for Python 3.6 and above
- Ensure all tests pass before submitting the PR
Code Style
We use:
- Black for code formatting
- isort for import sorting
- flake8 for linting
Please run these tools before submitting a PR:
black .
isort .
flake8
Or set up pre-commit hooks:
pip install pre-commit
pre-commit install
License
By contributing, you agree that your contributions will be licensed under the project's MIT License.