Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

88 lines (59 loc) · 3.11 KB

Contributing to Dester Desktop Client

Thank you for your interest in contributing to Dester Desktop Client, an open-source Electron-based media organizer app under the DesterLib project. We appreciate all contributions, whether they're related to code, documentation, bug reports, or feature suggestions.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Setup
  4. Pull Request Guidelines
  5. License

Code of Conduct

This project adheres to a Code of Conduct. By participating, you agree to uphold this code. Please report any behavior that violates the code to [email protected].

How to Contribute

Reporting Bugs

If you discover a bug or any issue, please help us by reporting it on GitHub Issues. Make sure to include:

  • Steps to reproduce the issue
  • The expected vs actual behavior
  • Any relevant screenshots or log files

Suggesting Features

We’re always looking to improve Dester Desktop Client. To suggest a new feature:

  • Create an issue using the Feature Request template on GitHub.
  • Provide a clear description of the feature.
  • Describe potential use cases and how it will benefit users.

Code Contributions

We welcome code contributions! Follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your changes (git checkout -b feature/your-feature).
  3. Make your changes and commit them with clear and descriptive messages.
  4. Push your branch to your fork (git push origin feature/your-feature).
  5. Submit a pull request (PR) to the main repository, including a description of your changes and linking any relevant issues.

Make sure your code follows the Code Guidelines and that it is properly tested.

Development Setup

To set up the project for development:

  1. Clone the repository:

    git clone https://github.com/DesterLib/Desktop.git
cd Desktop

  2. Install dependencies (using pnpm):

    pnpm install

  3. Run the app:

    pnpm start

  4. Run the tests (if applicable):

    pnpm test

Pull Request Guidelines

  • Keep PRs small and focused. Large pull requests are harder to review.
  • Include tests for your code. If you're fixing a bug, add a test that prevents the bug from reoccurring.
  • Adhere to the code style of the project.
  • Document changes in your code, particularly if they affect functionality or user interaction.
  • Link to relevant issues or feature requests in your pull request description.

Licensing

By contributing to Dester Desktop Client, you agree that your contributions will be licensed under the GNU Affero General Public License (AGPL), in alignment with the main repository's license.