First of all, thank you for considering contributing to Blocks for GitHub! We appreciate your time and effort to improve this project. This document provides a guide to help you contribute effectively.
Please review and follow our Code of Conduct to ensure a positive, inclusive, and collaborative environment.
There are many ways to contribute to this project:
- 🐛 Reporting bugs
- 🆕 Suggesting new features or enhancements
- 📚 Improving documentation
- 💻 Writing code and submitting pull requests
- 👀 Reviewing code
- 🌐 Helping with translations
- 💬 Participating in discussions
If you find a bug, please report it by creating a new issue in our issue tracker. Make sure to search for existing issues before submitting a new one to avoid duplicating reports. When reporting a bug, please provide as much information as possible, including:
- A clear and descriptive title
- A detailed description of the bug, including steps to reproduce it
- Your environment (OS, browser, software versions, etc.)
- Any relevant error messages or logs
- Screenshots or screen recordings if helpful
We welcome ideas for new features or enhancements. Please create a new issue in our issue tracker and include the following information:
- A clear and descriptive title
- A detailed description of the proposed feature or enhancement
- Explanation of the benefits or use cases
- Any relevant examples, mockups, or diagrams
Documentation is an essential part of any project. If you find any typos, grammatical errors, or unclear instructions, please feel free to submit a pull request with your suggested changes.
If you want to contribute code, please follow these steps:
- Fork the repository and create a new branch for your feature or bugfix
- Clone your fork locally
- Install the project dependencies
- Make your changes, following the coding standards and guidelines
- Test your changes and ensure they don't introduce new bugs
- Commit your changes, using clear and descriptive commit messages
- Push your changes to your fork
- Create a pull request against the main repository, providing a detailed description of your changes
We'll review your pull request as soon as possible and provide feedback. Please be patient and address any review comments or suggestions.
If you have the required knowledge and experience, you can also help by reviewing pull requests submitted by other contributors. Providing constructive feedback and suggestions will help maintain high-quality code and ensure the success of the project.
- GitHub Help: Collaborating with issues and pull requests
- GitHub Help: Forking a repository
- GitHub Help: Creating a pull request
Once again, thank you for your interest in contributing to Blocks for GitHub. We look forward to working together to make this project better! 🎉