Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

39 lines (21 loc) · 1.93 KB
Raw

Contributing to Summarization-Eval

We warmly welcome contributions to the Summarization-Eval project! If you would like to contribute, please follow the guidelines below.

How to Contribute

  1. Fork the Repository: Start by forking the repository on GitHub.

  2. Clone the Forked Repository: Clone your fork to your local machine.

  3. Create a New Branch: Create a new branch for your proposed changes. Naming your branch something descriptive about the changes you intend to make is helpful.

  4. Make Your Changes: Implement your changes, additions, or fixes in your branch. Be sure to keep your code clean and well-documented.

  5. Commit Your Changes: Commit your changes with clear and detailed commit messages. This helps others understand the purpose of your changes.

  6. Run the Tests: If there are any tests, run them to ensure your changes don't break existing functionality.

  7. Push Your Changes: Push your changes to your fork on GitHub.

  8. Submit a Pull Request: Go to the original project repository on GitHub and open a pull request from your branch to the main project. Provide as much information as possible about your changes and the reasons for them.

  9. Respond to Feedback: Be prepared to respond to feedback on your pull request. The project maintainers may request changes or clarifications.

Reporting Issues

If you find bugs or have suggestions for improvements, please open an issue in the GitHub issue tracker. Provide as much detail as possible, such as:

  • A clear and descriptive title
  • A detailed description of the issue or suggestion
  • Steps to reproduce the bug (if applicable)
  • Your environment information (OS, Python version, etc.)

Code of Conduct

All contributors are expected to adhere to the project's Code of Conduct. Respectful and constructive interactions are the foundation of a healthy open-source community.

Thank you for considering contributing to Summarization-Eval!