Contributing Guidelines¶
Thank you for your interest in contributing to RxConf!
Please take a moment to review the following guidelines before submitting your contribution.
Getting Started¶
Setup your development environment: Setup guide.
Submitting Contributions¶
When submitting your contribution, please ensure the following:
- Minimized count of commits.
- Your code follows our code style guidelines.
- Your changes are well-documented and include any necessary updates to the project's documentation.
- Your changes do not introduce any breaking changes or regressions.
- Provided descriptive commits' titles. Use emoji notation:
| Topic | Alias |
|---|---|
| Version tag | 🔖 :bookmark: |
| New feature | ✨ :sparkles: |
| Bugfix | 🐛 :bug: |
| Documentation | 📚 :books: |
| Performance | 🏇 :racehorse: |
| Tests | ✅ :white_check_mark: |
| General update | 🚀 :rocket: |
| Improve format/structure | 🎨 :art: |
| Refactor code | 🔨 :hammer: |
| Removing code/files | 🔥 :fire: |
| Continuous Integration | 👷 :construction_worker: |
| Security | 🔒 :lock: |
| Upgrading dependencies | ⬆️ :arrow_up: |
| Downgrading dependencies | ⬇️ :arrow_down: |
| Critical hotfix | 🚑 :ambulance: |
| Configuration files | 🔧 :wrench: |
| Reverting changes | ⏪ :rewind: |
| Breaking changes | 💥 :boom: |
| Movements | 🚚 :truck: |
Code Style¶
We follow a specific code style in our project. Please make sure to adhere to the following guidelines:
- Follow all PEP8 guidelines.
- Use meaningful variable and function names.
- Avoid of addition comments.
- Add docstrings for all public interfaces.
- Follow the main Clean Code patterns.
Testing¶
We highly encourage contributors to write tests for their code. Please ensure that your changes are thoroughly tested and that all existing tests pass.
Our goal is to have 100% of code coverage (for public interfaces).
Documentation¶
Documentation deploys automatically via pushing to main.
Improving the project's documentation is always appreciated. If you make any changes that require updates to the documentation, please include those updates in your contribution.
Issue Reporting¶
If you encounter any issues or have any suggestions for improvement, please open an issue on our issue tracker.
Provide as much detail as possible to help us understand and address the problem.