Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

76 lines (46 loc) · 3.05 KB
Raw

Contributing to Lowfi

First off, thank you for considering contributing to Lowfi! Your help is essential to the success of this project.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please open an issue on GitHub and provide as much detail as possible. Include steps to reproduce the issue, your environment (OS, Node.js version, npm version), and any relevant logs.

  1. Search for existing issues: Before creating a new issue, please check if it has already been reported.
  2. Create a new issue: If your issue hasn't been reported, please create a new issue and fill out the provided template.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, we would love to hear about it! Please open an issue on GitHub with a clear description of the enhancement.

  1. Search for existing issues: Before creating a new enhancement suggestion, please check if it has already been proposed.
  2. Create a new suggestion: If your suggestion is new, please create an issue and fill out the provided template.

Contributing Code

  1. Fork the repository: Click the "Fork" button at the top right corner of the repository page.

  2. Clone your fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/lowfi.git
cd lowfi

  3. Create a new branch: Create a new branch for your feature or bugfix.

    git checkout -b feature-or-bugfix-description

  4. Make your changes: Make your changes to the codebase. Please follow the existing code style and conventions.

  5. Commit your changes: Commit your changes with a clear and concise commit message.

    git commit -m "feat: description of your changes"

    Notice: Commit messages should follow Conventional Commits Specification.

  6. Push your changes: Push your changes to your forked repository.

    git push origin feature-or-bugfix-description

  7. Open a pull request: Open a pull request from your branch to the main branch of the original repository. Provide as much detail as possible.

Writing Documentation

Improving documentation is a valuable way to contribute to the project. If you find areas of the documentation that can be enhanced, please submit a pull request.

Pull Request Process

  1. Ensure your branch is up-to-date with the main branch.
  2. Submit your pull request. If your PR fixes an issue, please reference the issue number in the PR description.
  3. A project maintainer will review your PR and provide feedback if necessary.
  4. Once your PR is approved, it will be merged into the main branch.

License

By contributing, you agree that your contributions will be licensed under the project's LICENSE.

Thank You!

Thank you for considering contributing to Lowfi! Your contributions are greatly appreciated and help to improve the project for everyone.

If you have any questions or need further assistance, feel free to open an issue.