First off, thanks for taking the time to contribute! The following is a set of guidelines for contributing to our project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to bloqbit@cubicstudios.xyz.
If you find a bug, please open an issue. Before you create a new issue, please check if a similar issue already exists or has been closed recently.
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show the problem.
Enhancement suggestions are always welcome! Please follow these steps when suggesting:
- Use a clear and descriptive title for the issue.
- Provide a detailed description of the suggested enhancement.
- Explain why this enhancement would be useful.
To contribute a code change, follow these steps:
- Fork the repository.
- Create a new branch for your changes:
git checkout -b my-feature-branch. - Make your changes.
- Commit your changes:
git commit -m 'Add some feature'. - Push to the branch:
git push origin my-feature-branch. - Open a pull request: Provide a clear and descriptive title and description for your pull request.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.
- Follow the style guide of the language you are working in.
- Ensure your code is properly formatted and linted.
- Include comments to explain complex logic and algorithms.
- If you're unsure about anything, feel free to ask. We're here to help!
- Contributions of all kinds are welcome, including documentation, bug fixes, and new features.
By following these guidelines, you help ensure that our project remains consistent, collaborative, and high-quality. Thank you for being a part of our community!