Thank you for your interest in contributing to Code-Trove! We welcome contributions of all kinds to make this project better for everyone. Whether you're fixing a bug, creating new features, improving documentation, or participating in discussions, your help is appreciated.
If you find a bug, please let us know by creating an issue:
- Go to the Issues section.
- Click on New Issue.
- Provide a clear and descriptive title.
- Add details, including steps to reproduce the issue, expected behavior, and screenshots if applicable.
Have an idea for a new feature? We'd love to hear it! Follow these steps:
- Open an issue with the label Feature Request.
- Describe the feature and its potential benefits.
- Include examples or references if possible.
Documentation is key to making Code-Trove accessible to everyone. You can help by:
- Fixing typos or grammatical errors.
- Adding examples or clarifying explanations.
- Updating outdated sections.
If you want to contribute code, follow these steps:
- Click the Fork button at the top of the repository page.
- Clone your fork to your local machine:
git clone https://github.com/your-username/your-repository.git
- Use a descriptive branch name:
git checkout -b feature/YourFeatureName
- Ensure your code follows the project's style guidelines.
- Write clear and concise commit messages:
git commit -m "Add description of changes"
- Push your branch to your forked repository:
git push origin feature/YourFeatureName
- Go to the original repository and click Pull Requests.
- Click New Pull Request and select your branch.
- Provide a detailed description of your changes.
To maintain code quality and consistency:
- Follow the Project Style Guide:
- Use clear, readable code with appropriate comments.
- Follow naming conventions and folder structures.
- Write Tests:
- Add unit tests for new features or bug fixes.
- Ensure all existing tests pass before submitting your changes.
- Check Linting:
- Run linters and fix any issues.
- Be respectful and inclusive in your interactions.
- Review our Code of Conduct before contributing.
- Constructive feedback is always welcome, but personal attacks will not be tolerated.
If you have any questions or need help getting started:
- Email: opensource.github24@gmail.com
- Discord: Join our server
Thank you for contributing to Code-Trove! Together, we can create something amazing.