Skip to content

Latest commit

 

History

History
40 lines (20 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

40 lines (20 loc) · 2.68 KB
Raw

Awesome LLM Interpretability - Collaborating Guidelines

We welcome contributions from the community to make the Awesome LLM Interpretability project even more valuable. To ensure smooth collaboration and maintain the quality of the project, we have established the following guidelines for contributors:

How to Contribute

  1. Fork the Repository: Start by forking the Awesome LLM Interpretability repository to your own GitHub account.

  2. Create a Branch: Create a new branch in your forked repository for your contributions. It's a good practice to name the branch based on the feature or fix you're working on.

  3. Make Changes: Make your desired changes, improvements, or additions to the project. Please follow the project's style and formatting guidelines.

  4. Testing: If your contribution involves code changes, ensure that the code passes all existing tests. If relevant, add new tests to cover your changes.

  5. Commit Changes: Commit your changes with clear, descriptive commit messages. Reference any related issues or pull requests using issue numbers (e.g., "Fixes #123").

  6. Create a Pull Request (PR): Once your changes are ready, create a pull request from your forked repository to the main Awesome LLM Interpretability repository. Provide a detailed description of your changes in the PR.

  7. Review and Feedback: Your PR will be reviewed by project maintainers and other contributors. Be responsive to feedback and make necessary updates to address any issues or concerns raised during the review.

  8. Merging: Once your PR is approved and passes all checks, it will be merged into the main branch by a project maintainer.

Code of Conduct

Contributors are expected to adhere to the Code of Conduct at all times when participating in the project. Respectful and inclusive behavior is essential for a positive collaborative environment.

Licensing

By contributing to the Awesome LLM Interpretability project, you agree that your contributions will be licensed under the same license as the project itself. Be sure to review the project's license (usually found in the repository's root directory) before contributing.

Attribution

We value and appreciate all contributions to the project. Contributors may be recognized in the project's documentation or credits section as a token of appreciation for their efforts.

Questions and Assistance

If you have any questions, need assistance, or want to discuss potential contributions before getting started, feel free to reach out to the project maintainers or the community in the relevant communication channels.

Thank you for your interest in collaborating on the Awesome LLM Interpretability project!