Kurocado Studio Styleguide Help

Contributing

Thank you for your interest in contributing! We appreciate your efforts to help improve and maintain our codebase. By contributing, you agree to abide by our guidelines outlined below.

NOTE: Actual adoption of your library is not guaranteed. Offloading maintenance and adaptability is a delicate balance.

Code of Conduct

Please read and follow our Code of Conduct to ensure a welcoming and respectful environment for everyone.

How to Contribute

Reporting Issues

If you encounter a bug or have a question, please open an issue on GitHub. When reporting an issue, please include:

  • A clear and descriptive title.

  • A detailed description of the problem.

  • Steps to reproduce the issue.

  • Any relevant screenshots or error messages.

Suggesting Enhancements

We welcome suggestions for improvements and new features. To propose an enhancement:

  1. Search existing issues to avoid duplicates.

  2. If none exist, open a new issue with:

    • A descriptive title.

    • A clear description of the enhancement.

    • The benefits and potential impact of the change.

Submitting Pull Requests

We appreciate your contributions! To submit a pull request (PR):

  1. Fork the Repository

    • Click the "Fork" button at the top of the repository page to create your own copy.

  2. Make Your Changes & Follow the Style Guidelines.

  3. Open a Pull Request & Follow the Style Guidelines.

    • Go to the original repository and click “Compare & pull request”.

    • Provide a clear and descriptive title and description for your PR.

    • Reference any related issues using keywords like Closes #issue-number.

Acknowledgements

  • All contributors who have helped improve our projects.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Last modified: 23 October 2024