First off, thank you for considering contributing to Alpaca-Turbo! We appreciate your effort and time to make this project better. This document provides guidelines and instructions for contributing to the project.
By participating in this project, you are expected to uphold our Code of Conduct.
- Fork the repository and clone it to your local machine.
- Set up the development environment by following the instructions in the README file.
- Explore the codebase, run tests, and verify that everything works as expected.
If you find any bugs or issues, please report them by opening a new issue on GitHub. When reporting a bug, please provide the following information:
- A clear and descriptive title.
- A detailed description of the issue and steps to reproduce it.
- The expected behavior and the actual behavior.
- Any error messages or logs related to the issue.
- The version of the software you are using.
If you have ideas for new features or enhancements, we would love to hear them! Please open a new issue on GitHub and describe your suggestion in detail.
- Create a new branch for your feature or bugfix. Use a descriptive name like
feature/your-feature-nameorfix/your-bugfix-name. - Make your changes, following the Style Guidelines below.
- Test your changes and ensure that they don't introduce new issues or break existing functionality.
- Commit your changes, following the commit message guidelines.
- Push your branch to your fork on GitHub.
- Open a new pull request against the
mainbranch of the Wolverine repository. Include a clear and concise description of your changes, referencing any related issues.
Wolverine uses PEP 8 as its code style guide. Please ensure that your code follows these guidelines. We recommend using a linter like flake8 to check your code style before committing.
Write clear and concise commit messages that briefly describe the changes made in each commit. Use the imperative mood and start with a capitalized verb, e.g., "Add new feature" or "Fix bug in function".