We are excited that you want to contribute to cf-helper! This document will guide you through the contribution process, from reporting issues to submitting pull requests.
- How to Contribute
- Reporting Bugs
- Suggesting Features
- Pull Request Process
- Contribution Guidelines
- Documentation
You can contribute in several ways
- Reporting bugs.
- Suggesting new features.
- Submitting pull requests with fixes or improvements.
- Improving documentation.
We welcome all contributions, but please ensure that your pull requests align with the project's vision and coding standards.
If you find a bug, please open an issue and include:
- A clear title and description.
- Steps to reproduce the bug.
- Expected Behavior.
- Relevant logs, screenshots, or code snippets if available.
Feature suggestions are welcome! Please open an issue and provide:
- A detailed description of the feature.
- Use cases for the feature.
- Any screenshots, if applicable.
-
Fork the repository and create your branch from main:
git checkout -b feature/new-feature -
Commit your changes with clear and descriptive commit messages:
git commit -m "Add feature: implement pagination" -
Push your branch to your forked repository:
git push origin feature/new-feature -
Open a pull request:
- Ensure your pull request title and description are clear.
- Reference any related issues or feature requests.
- Tag reviewers, if necessary.
- Make sure your code follows the project’s coding conventions.
- Write clear and concise commit messages.
- Test your changes before submitting.
- If you're working on a big feature, it’s a good idea to first open an issue to discuss it.
Update documentation as necessary for any changes you make. This includes updating the README.md file and any other relevant documentation files