Skip to content

Latest commit

 

History

History
60 lines (33 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

60 lines (33 loc) · 3.44 KB
Raw

Contribution Guidelines for Liny

Introduction and Project Overview

Liny is an open-source customer feedback management platform, designed as an alternative to Canny. It aims to provide a robust and flexible solution for businesses to collect, organize, and respond to customer feedback effectively.

How to Contribute

There are several ways you can contribute to the Liny project:

  1. Reporting Bugs or Issues: If you encounter any bugs or issues while using Liny, please report them in the GitHub issues section.

  2. Submitting Feature Requests: If you have an idea for a new feature or enhancement, you can submit a feature request in the GitHub issues section.

  3. Contributing Code: If you'd like to contribute code, such as fixing bugs or implementing new features, please follow these steps:

    • Fork the repository
    • Create a new branch for your changes
    • Submit a pull request for your changes

    Detailed steps are available in the Development Guide.

  4. Improving Documentation: You can help improve the project's documentation by correcting errors, adding new content, or enhancing existing documentation.

  5. Providing Feedback or Suggestions: You can share your feedback, ideas, or suggestions for the project by participating in the Discord server.

Development Workflow

  1. Forking the Repository: Start by forking the Liny repository to your own GitHub account.
  2. Creating a New Branch: Create a new branch for your changes, using a descriptive name that reflects the nature of your contribution.
  3. Submitting a Pull Request: Once you've made your changes, submit a pull request to the dev branch of the main repository. Please include a detailed description of your changes and any relevant information.

Coding Style and Conventions

Liny follows the Conventional Commits standard for commit messages. We also use ESLint and Prettier to enforce code style and formatting.

Testing (Yet to be implemented)

Contributors are expected to write unit tests for any new features or bug fixes. You can run the existing tests using the project's testing framework.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please report them in the GitHub issues section. When reporting an issue, please provide detailed information, including steps to reproduce the problem, expected behavior, and actual behavior.

Communication Channels

  • Discord Server: Join our Discord server to discuss the project, ask questions, and collaborate with other contributors.
  • GitHub: Use the GitHub issues section to report bugs, submit feature requests, and discuss the project.

Code of Conduct

All contributors are expected to follow the project's Code of Conduct.

Recognition

We appreciate all contributions to the Liny project. Contributors will be recognized in the project's .all-contributorsrc file.

License

Liny is licensed under the AGPL-3.0 license.