Contribute.md

Contributing to ScribbleLabDocsKit

Thank you for your interest in contributing to ScribbleLabDocsKit! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more.

Getting Started

1. Join the Community
   Connect with us on Discord to discuss ideas, ask questions, and collaborate with other contributors.

2. Understand the Project
   Familiarize yourself with the project by reading the README and exploring the codebase.

3. Code of Conduct
   Please read and adhere to our Code of Conduct to ensure a welcoming environment for everyone.

How to Contribute

Reporting Issues

• Search the issue tracker to see if your issue has already been reported.
• If not, create a new issue with a clear and descriptive title and detailed information.

Submitting Code

1. Fork the Repository
   Fork the repository and clone it to your local machine.

2. Set Up Your Environment
   Follow the Setup Guide to prepare your development environment.

3. Follow Code Style Guidelines
   Ensure your code adheres to our Code Style Guidelines.

4. Write Tests
   Add or update tests to cover your changes. Refer to the Testing Guide for details.

5. Commit Changes
   Write clear and concise commit messages. Follow the Conventional Commits specification.

6. Submit a Pull Request
   Push your changes to your fork and open a pull request. Include a detailed description of your changes and reference any related issues.

Improving Documentation

• Fix typos, clarify instructions, or add new sections to improve the documentation.
• Submit your changes as a pull request.

Resources

• Discord: Join our community
• Issue Tracker: View open issues
• Code Style Guidelines: Read the guidelines
• Testing Guide: Learn about testing

Need Help?

If you have any questions or need assistance, feel free to reach out on Discord or open a discussion in the GitHub Discussions.

We appreciate your contributions and look forward to collaborating with you!