Contributing Guidelines
Guidelines for contributing to the Twistail project.
Before making changes, please discuss your planned contributions via issue, email, or other channels with the repository owners. This helps us provide guidance and feedback early in the process.
Follow our Code of Conduct in all project interactions.
🤝 Pull Request Process
- Fork repository - Create a copy of the repository in your GitHub account.
- Create feature branch - Make a new branch from the main branch, use descriptive names.
- Make your changes - Develop your planned feature or fix. Ensure code follows project standards.
- Run tests and linting - Execute all test suites and linting to verify changes don't break existing features.
- Push changes to fork - Upload your changes to your forked repository on GitHub.
- Open pull request - Create PR from your fork's branch to the main repository. Include clear title and description.
- Pass checks & resolve conflicts - Ensure all automated checks pass and no conflicts exist with the main branch.
- Address review feedback - Respond to reviewer comments with improvements or constructive discussion.
- Get merged - Once approved, your changes will be merged into the main codebase.
For detailed guidance, see GitHub's Pull Request documentation.
🏁 Getting Started
To set up local development:
- Clone repository
- Install dependencies
- Configure environment
- Run development server
🧑🏻💻 Development Guidelines
- Write clear commit messages
- Add tests for new features
- Update documentation
- Follow code style guidelines
- Keep changes focused and atomic
🚀 Release Process
New releases follow semantic versioning:
- Major: Breaking changes
- Minor: New features
- Patch: Bug fixes
📝 License
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Edit on GitHub
Last updated on 3/17/2025