Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.08 KB

HOW_TO_CONTRIBUTE.md

File metadata and controls

51 lines (32 loc) · 2.08 KB
Raw

Welcome to BELLE project! We appreciate your interest in contributing to our project. In order to make the contribution process as smooth as possible, we have established some guidelines to help you submit your contributions. Please take a few minutes to review the following guidelines before you start contributing.

How to Contribute Code

  1. Fork the repository and clone it locally.
  2. Create a new branch for your contribution using a descriptive name.
  3. Make your changes and ensure that they are properly tested.
  4. Submit a pull request to the master branch of our repository.

How to Contribute Data

If you are contributing prompts or prompt seeds, please open up a new issue with the following title format: [New Prompt]: or [New Prompt Seed]:.

If you are contributing new dataset:

  1. Please check the format of our official dataset.
  2. Upload your dataset somewhere, e.g. HuggingFace.
  3. Create a new issue of the title: [Contributing Data]:. Describe the dataset, e.g. scale, contents, etc.
  4. Include link to your dataset in the issue.

Contribution Guidelines

Please ensure that your contributions adhere to the following guidelines:

  1. Follow the coding style and conventions used in the project.
  2. Make sure that your contribution is well-documented and easy to understand
  3. Keep your contributions concise and focused. If you are making multiple changes, consider breaking them into separate pull requests.
  4. Do not submit contributions that include proprietary or confidential information.

Reporting Issues

If you encounter any issues while using our project, please report them through our issue tracker. Please provide as much information as possible about the issue, including steps to reproduce the problem.

Before submitting an issue, please search through existing issues first :)

Conclusion

Thank you for taking the time to read through these guidelines. We appreciate your contributions and look forward to working with you! If you have any questions or concerns, please reach out to the project maintainers.