Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 2.73 KB

contributing.md

File metadata and controls

66 lines (40 loc) · 2.73 KB
Raw

Contributing to Sol

Welcome to the Sol programming language project! We appreciate your interest in contributing to the development of Sol. By contributing, you're helping to improve the language and make it even more powerful and versatile.

How to Contribute

To contribute to Sol, please follow these guidelines:

  1. Fork the Repository: Start by forking the Sol repository to your own GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine using the following command:

git clone https://github.com/BedrockFrontiers/sol.git
  1. Create a Branch: Before making any changes, create a new branch to work on your contribution:
git checkout -b my-contribution

  1. Make Changes: Make your desired changes to the codebase. Ensure that your changes adhere to the coding standards and guidelines of the project.

  2. Test Your Changes: Test your changes thoroughly to ensure they work as expected and do not introduce any regressions.

  3. Commit Your Changes: Once you're satisfied with your changes, commit them to your branch:

git add .
git commit -m "Add your commit message here."
  1. Push Changes: Push your changes to your forked repository on GitHub:
git push origin my-contribution
  1. Submit a Pull Request: Finally, submit a pull request from your branch to the main Sol repository. Be sure to provide a clear description of your changes and why they are beneficial.

Code Style and Guidelines

When contributing to Sol, please adhere to the following guidelines:

  • Follow the coding style and conventions used throughout the codebase.
  • Write clear and concise code with appropriate comments where necessary.
  • Test your changes thoroughly to ensure they do not introduce bugs or regressions.
  • Document any new features, APIs, or significant changes in the appropriate documentation files.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please report them using the GitHub issue tracker. Be sure to provide detailed information about the problem and steps to reproduce it.

Getting Help

If you need assistance or have questions about contributing to Sol, feel free to reach out to the project maintainers or community members. You can also refer to the documentation and resources available in the repository.

License

By contributing to Sol, you agree to license your contributions under the terms of the Apache License 2.0. You also affirm that you have the necessary rights to contribute your code and that your contributions do not violate any third-party rights.

Thank you for your contributions to Sol! Together, we can make Sol a powerful and efficient language for automation.