Skip to content
This repository was archived by the owner on Mar 30, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (18 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 1.17 KB

Contributing to Docky

Thank you for your interest in contributing to Docky! We welcome contributions from everyone, and are grateful for every pull request.

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes.
  3. Make your changes and commit them to your branch.
  4. Push your branch to your fork on GitHub.
  5. Open a pull request from your fork to the main repository.
  6. Pick an issue to work on or pick a feature to add from here.

Code Style

Please use rustfmt to format your code. Please make sure to run cargo fmt before submitting a pull request.

Testing

Please attach images of your changes to the app to the pull request.

Pull Request Guidelines

  • Please ensure that your pull request is not a duplicate of an existing pull request.
  • Please ensure that your pull request is not a duplicate of an existing issue.
  • Please ensure that your changes are well-documented (at least in the PR) and include updates to the README.md file / example configuration if necessary.
  • Please ensure that your changes do not break any existing functionality.