Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 2.52 KB
Raw

Contributing guidelines

Thank you for your interest in contributing to Ktorfit! Before submitting a pull request, we kindly request that you follow these guidelines:

  1. Feature Requests: If you have an idea for a new feature or enhancement, please create a feature request in GitHub Issues. This allows the community to discuss and provide feedback on the proposed changes before any code is written.

  2. Reporting Bugs

If you encounter a bug or have a specific issue to report, please follow these steps:

GitHub Issue Tracker: Use the GitHub Issue Tracker to report the bug. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant error messages or logs.

Search for Existing Issues: Before creating a new issue, search the existing issues to see if the bug has already been reported. If you find a similar issue, you can add any additional information or reproduce the issue on that existing thread.

When you already know how to fix the bug, feel free to send a Pull Request for it.

Coding

  1. Fork the repo
  2. Create a branch in your fork (prefer - in naming rather than _)
  3. Implement your changes in your branch
    • Make sure your branch contains changes limited to the scope of the task
    • Dependency updates should be standalone PRs whenever possible
    • Implement tests if applicable
  4. Do a round of manual QA
  5. Update docs/changelog.md if applicable
  6. Update documentation if applicable
  7. Push to your fork's branch, open a PR

Trivial fixes (typo, easy-to-fix compilation error, etc.) don't need to go through this process

Documentation

  • docs - contains the source for the GitHub page

When updating the documentation, test the generated MkDocs site locally.

Setup

Prerequisites

  • Python
python3 -m pip install --upgrade pip     # install pip
python3 -m pip install mkdocs            # install MkDocs 
python3 -m pip install mkdocs-material   # install material theme
python3 -m pip install mkdocs-git-revision-date-localized-plugin
python3 -m pip install mkdocs-minify-plugin
python3 -m pip install mkdocs-macros-plugin

Run

mkdocs serve

Check the console output for a localhost url, most probably something like:

INFO     -  [09:41:08] Serving on http://127.0.0.1:8000/Foso/Ktorfit

Open the url in your browser. Changes are automatically deployed by MkDocs while the server is running.