Welcome to build-compiler-js! We appreciate your interest in contributing to our open source project. This guide will help you get started with the contribution process.
- Fork the repository to your GitHub account.
- Clone the forked repository to your local machine.
- Create a new branch for your contribution:
git checkout -b my-contribution. - Make your changes or additions to the codebase.
- Test your changes thoroughly to ensure they don't introduce any issues.
- Commit your changes:
git commit -m "Add a descriptive commit message". - Push the changes to your forked repository:
git push origin my-contribution. - Create a pull request from your forked repository to the main repository.
- Wait for the maintainers to review and provide feedback on your pull request.
- Make any necessary updates to address the feedback until your pull request is approved.
To ensure smooth collaboration and maintain code quality, please follow these guidelines:
- Follow the existing code style and conventions used in the project.
- Write clear, concise, and meaningful commit messages.
- Include relevant documentation and tests when applicable.
- Be respectful and considerate of other contributors.
We use GitHub Issues to track and manage tasks, bug reports, and feature requests. If you find a bug or have an idea for a new feature, please check the existing issues to avoid duplicates. If your issue is new, feel free to create a new one.
Please note that we have a Code of Conduct in place to foster a positive and inclusive community. By participating in this project, you are expected to adhere to the Code of Conduct. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers.
If you have any questions or need further assistance, you can reach out to us by email.
Thank you for your interest in contributing to build-compiler-js. We look forward to your contributions!