Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.43 KB
Raw

Contributing to Lingo

Thank you for your interest in contributing to Lingo! We welcome contributions from the community to help improve and enhance this project. Your efforts can make a meaningful difference.

Before you start contributing, please take a moment to review the following guidelines and steps to ensure a smooth collaboration:

Getting Started

  1. Fork the lingo repository on GitHub.
  2. Clone your forked repository to your local development environment.
  3. Create a new branch for your contributions: git checkout -b username/feature-name

Making Changes

  • Please make your changes, additions, or fixes in your branch.
  • Follow the project's coding style and conventions.
  • Ensure that your code is well-documented.
  • Make sure your changes do not break existing functionality.

Commit convention

  • Please follow the project commit conventions.
  • Seperate commits to be made for changes done in frontend and server code.
  • The commit message should be prefix with UI or Server reflecting the changes of respective directory.
  • Example commit message for changes done in frontend code: git commit -m "[UI]: add useLanguage hook"
  • Example commit message for changes done in server code: git commit -m "[Server]: add send message on quiz time over"

Testing

  • Test your changes thoroughly to ensure they work as expected.
  • Write tests if necessary to cover new functionality.
  • Ensure that all existing tests still pass.

Pull Request

  • Push your changes to your forked repository: git push origin username/your-feature-name
  • Create a pull request from your branch to the master branch of the lingo repository.
  • Provide a clear and concise description of your changes in the pull request.
  • Ensure your pull request title and description follow the project's guidelines.

Code Review

  • Be prepared to address feedback and iterate on your changes if needed.
  • Maintain a positive and collaborative attitude during the review process.

Community Guidelines

  • Please be respectful and considerate when interacting with other contributors and maintainers.
  • Follow the project's Code of Conduct.

Acknowledgment

By contributing to lingo, you agree that your contributions will be licensed under the MIT License.

Thank you for being a part of the lingo community. Your contributions are greatly appreciated!