Skip to content

Latest commit

 

History

History
executable file
·
72 lines (46 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
72 lines (46 loc) · 3.72 KB
Raw

Contributing to llama-github

Thank you for your interest in contributing to the llama-github project! We welcome contributions from the community to help improve and enhance the library. This document outlines the guidelines and best practices for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read and follow the guidelines to ensure a welcoming and inclusive environment for all contributors.

Getting Started

To get started with contributing to llama-github, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main repository.

Development Setup

To set up the development environment for llama-github, follow these steps:

  1. Ensure you have Python 3.6 or above installed on your system.
  2. Create a virtual environment for the project.
  3. Install the required dependencies by running pip install -r requirements.txt.
  4. Install the development dependencies by running pip install -r requirements-dev.txt.
  5. Run the tests to ensure everything is set up correctly by executing pytest.

Contribution Guidelines

When contributing to llama-github, please keep the following guidelines in mind:

  • Follow the PEP 8 style guide for Python code.
  • Write clear and concise commit messages that describe the changes made.
  • Include tests for any new functionality or bug fixes.
  • Update the documentation, including docstrings and README, if necessary.
  • Ensure that your changes do not introduce any breaking changes unless discussed and approved by the maintainers.
  • Be respectful and constructive in all interactions with other contributors.

Issue Tracking

If you encounter a bug, have a feature request, or want to discuss an improvement, please submit an issue on the GitHub issue tracker. When submitting an issue, provide as much detail as possible, including steps to reproduce the problem or a clear description of the proposed feature.

Pull Request Process

When submitting a pull request, please follow these steps:

  1. Ensure that your changes are based on the latest version of the main branch.
  2. Provide a clear and descriptive title for your pull request.
  3. Include a detailed description of the changes made and the problem they solve or the feature they add.
  4. Reference any related issues or pull requests using the # symbol followed by the issue or pull request number.
  5. Ensure that all tests pass and that your changes do not introduce any new warnings or errors.
  6. Be prepared to address any feedback or requests for changes during the code review process.

Code Review

All pull requests will be reviewed by the project maintainers. During the review process, the maintainers may provide feedback, request changes, or ask for clarification. Please be responsive to the feedback and address any requested changes in a timely manner.

License

By contributing to llama-github, you agree that your contributions will be licensed under the Apache License 2.0.

Recognition

We value and appreciate all contributions to the llama-github project. Your contributions will be recognized in the project's release notes and contributor list.

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainers at Voldemort.xu@foxmail.com.

Thank you for your contributions and happy coding!