Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.8 KB

Contributing to Freelens

Thank you for considering contributing to Freelens! We value your support and are open to collaboration. Here are some guidelines to help you get started.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please check the existing issues to see if it has already been reported. If not, you can create a new issue. Please provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Your environment (OS, Freelens version, installation method)

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix (git checkout -b feature-name).
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Commit your changes (git commit -m 'Add some feature').
  6. Push to the branch (git push origin feature-name).
  7. Create a pull request.

Please ensure your pull request adheres to the following guidelines:

  • Describe the purpose of the pull request.
  • Reference any related issues.
  • Ensure all tests pass.
  • Follow the coding standards described in the Style Guides section.

Development Environment Setup

Read the DEVELOPMENT.md document to learn how to build and run the application from source files.

Style Guides

Code Style

  • Follow the existing coding style.
  • Use ESLint to lint your code.
  • Use Prettier for code formatting.
  • Verify your changes with Trunk Check.

Commit Messages

  • Write clear and descriptive commit messages.
  • Reference related issues or pull requests when applicable.

Community

Join our Discussions for general questions and community support.