Skip to content

Latest commit

 

History

History
64 lines (33 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

64 lines (33 loc) · 2.37 KB
Raw

Contributing to LRU8

Thank you for considering contributing to LRU8! Contributions are welcome and appreciated. To help make the process as smooth as possible, please review the guidelines below before getting started.

How to Contribute

  1. Fork the Repository: Click the "Fork" button in the top-right corner of this repository's page to create a copy of the repository in your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using the following command:

git clone https://github.com/your-username/LRU8.git

Replace `your-username` with your GitHub username.
  1. Create a Branch: Create a new branch for your contribution:

git checkout -b feature/new-feature

Replace `feature/new-feature` with a descriptive name for your branch.

  1. Make Changes: Make your desired changes to the codebase.

  2. Test Your Changes: Ensure that your changes do not introduce any errors or issues. Run any relevant tests to verify the functionality of your changes.

  3. Commit Your Changes: Commit your changes with a descriptive commit message:

git commit -am "Add new feature"

  1. Push Changes: Push your changes to your forked repository:

git push origin feature/new-feature

  1. Create a Pull Request: Go to the Pull Requests tab of the original repository and click on "New Pull Request". Follow the prompts to create a new pull request with your changes.

Code Style and Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear and descriptive commit messages.
  • Keep code changes focused and concise.
  • Ensure that your changes do not introduce any new warnings or errors.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

Conduct

We expect all contributors to adhere to our Code of Conduct when participating in our community, both online and offline.

License

Community

Join the conversation and discuss LRU8 with other developers:

License

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