Contributing

Contributing 🤝

We welcome contributions to SnapCache! Your help makes this project better for everyone. Below are guidelines on how you can get involved.

How to Contribute

1. Reporting Bugs 🐞

If you find a bug in SnapCache, please report it by creating an issue on our GitHub Issues page. Be sure to include:

• A clear description of the issue
• Steps to reproduce the problem
• Your environment (Node.js version, OS, etc.)
• Any error messages or logs

2. Suggesting Features ✨

We’re always looking for ways to improve SnapCache. If you have a feature in mind, let us know! Open an issue and describe:

• The feature you would like to see
• How it would benefit users
• Any additional context or requirements

3. Pull Requests (PRs) 🌟

To contribute code, please follow these steps:

1. Fork the repository: Click on the "Fork" button at the top right of the SnapCache GitHub page.
2. Clone your fork: Use the following command to clone it to your local machine:

   git clone https://github.com/blueboxlab/SnapCache.git

3. Create a new branch: Before making any changes, create a new branch for your work:

   git checkout -b feature/your-feature-name

4. Make your changes: Implement the feature or fix the bug. Be sure to add tests if applicable!
5. Commit your changes: Write clear commit messages explaining your changes:

   git commit -m "Add feature: your feature description"

6. Push to your fork: Push your changes back to your fork:

   git push origin feature/your-feature-name

7. Open a pull request: Go to the original SnapCache repository and click on the "Pull Requests" tab. Click "New Pull Request," select your branch, and provide a description of your changes.

4. Code Style and Best Practices

To maintain code quality, please adhere to the following:

• Follow existing code style (e.g., indentation, naming conventions).
• Write clear, descriptive commit messages.
• Include tests for new features or bug fixes.
• Ensure all tests pass before submitting a pull request.

5. Documentation

If you notice areas where the documentation can be improved or expanded, feel free to update the relevant wiki pages or README files. Clear documentation is vital for user understanding and adoption.

Community Guidelines

To foster a positive environment, please adhere to our community guidelines:

• Be respectful and considerate to others.
• Provide constructive feedback and be open to suggestions.
• Focus on issues related to SnapCache and avoid off-topic discussions.

License 📝

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

Questions?

If you have any questions about contributing or need assistance, feel free to reach out on our Discord server or create an issue on GitHub.

Thank you for considering contributing to SnapCache! Your efforts help make this project better for everyone. 🙌