Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 1.47 KB
Raw

Contributing Guidelines

Thank you for considering contributing to the LEAF project! We appreciate your help in making this language learning platform even better. Here are some guidelines to follow when contributing:

Getting Started

  1. Fork the repository and clone it to your local machine:

    git clone https://github.com/SudoKMaar/leaf.git
cd leaf

  2. Install dependencies:

    npm install

  3. Create a new branch for your feature or bug fix:

    git checkout -b feature/my-awesome-feature

Code Style

  • Follow the existing code style and conventions.
  • Use meaningful variable and function names.
  • Write clear and concise comments.

Submitting Changes

  1. Commit your changes with descriptive commit messages:

    git add .
git commit -m "feat: Implement user progress tracking"

  2. Push your changes to your forked repository:

    git push origin feature/my-awesome-feature

  3. Create a pull request (PR) against the main branch of the original repository.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on the issue tracker.

Code of Conduct

Please review our Code of Conduct before contributing.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. See LICENSE for details.