Pull Request Guidelines
How to submit pull requests to DevView.
[Placeholder: Insert screenshot or diagram of the pull request workflow. Use a device frame if relevant.]
Before You Submit
- Ensure your branch is up to date with main
- Run all tests and code quality checks
- Review your changes for clarity and completeness
- Update documentation if needed
Opening a Pull Request
- Use a clear, descriptive title and summary
- Reference related issues or discussions
- Assign reviewers if possible
- Mark as draft if not ready for review
Process
- Fork the repository
- Create a feature branch
- Make your changes
- Write/update tests
- Update documentation
- Run code quality checks
- Submit pull request
Branch Naming
- feature/description - New features
- fix/description - Bug fixes
- docs/description - Documentation
- refactor/description - Refactoring
Commit Messages
Follow conventional commits:
feat: add new module
fix: correct navigation issue
docs: update README
refactor: improve code structure
Checklist
- [ ] Tests pass
- [ ] Detekt passes
- [ ] Documentation updated
- [ ] CHANGELOG updated
Review Process
- PRs are reviewed by maintainers. Be responsive to feedback.
- Respond to feedback promptly and constructively
- Make requested changes and push updates
- Resolve merge conflicts as needed
After Approval
- Squash and merge if appropriate
- Delete your feature branch after merging
- Celebrate your contribution!
Next Steps
- See Code Style for formatting and linting rules
- Review Development Setup for environment configuration
- See Code of Conduct for community standards
If you have questions about pull requests, open an issue or start a discussion on GitHub.