Skip to content

Latest commit

 

History

History
91 lines (55 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

91 lines (55 loc) · 3.94 KB
Raw

SEA-LION Contributing Guide

Thank you for considering contributing to SEA-LION! We welcome contributions from the community to help improve and enhance our language model for Southeast Asia. Whether you're a developer, researcher, or just an enthusiast, there are various ways you can get involved and make a meaningful impact.

Before you begin, please take a moment to review this guide, which outlines the contribution process, code of conduct, and how to get help if needed.

Table of Contents

Getting Started

Before you start contributing, please ensure you have the following:

  • A GitHub account: If you don't have one, you can create an account here.
  • Familiarity with Git: You'll need to know the basics of Git for version control.

Contributing to SEA-LION

There are several ways you can contribute to SEA-LION:

Reporting Bugs

If you encounter any issues, bugs, or unexpected behavior while using SEA-LION, please help us by reporting them. To report a bug:

  1. Check if the issue has already been reported by searching the GitHub Issues page.
  2. If not, create a new issue with a descriptive title and detailed description of the problem you encountered.
  3. Include relevant information such as your operating system, Python version, and any error messages.

Suggesting Enhancements

We appreciate your suggestions for improving SEA-LION. If you have an idea for an enhancement or new feature, follow these steps:

  1. Check if your suggestion has already been proposed in the GitHub Issues section.
  2. If not, create a new issue with a clear and concise title and a detailed description of your suggestion.
  3. Include any relevant context or examples to illustrate the enhancement's value.

Code Contribution

If you're interested in contributing code to SEA-LION, you can do so by following these steps:

  1. Fork the SEA-LION repository to your GitHub account.

  2. Clone your forked repository to your local machine:

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

  3. Create a new branch for your contribution:

    git checkout -b feature/your-feature-name

  4. Make your changes and commit them with clear and concise commit messages.

  5. Push your changes to your forked repository:

    git push origin feature/your-feature-name

  6. Create a pull request (PR) from your branch to the main SEA-LION repository.

  7. Ensure your PR includes a detailed description of the changes, why they are necessary, and any relevant testing or documentation updates.

  8. Participate in the review process, addressing any feedback or requested changes.

  9. Once your PR is approved, it will be merged into the main repository.

Development Setup

If you want to contribute code, you'll need to set up a development environment for SEA-LION. Refer to the Development Setup guide in the repository for detailed instructions on getting started.

Code of Conduct

Please review and adhere to our Code of Conduct. We expect all contributors and community members to treat each other with respect and kindness.

Get Help

If you have questions, need assistance, or want to discuss contributions further, please feel free to contact us or open an issue for discussion.

We appreciate your interest in contributing to SEA-LION, and we look forward to collaborating with you!