CONTRIBUTING.md

December 25, 2024 ยท View on GitHub

Contributing Guide

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub How to contribute summary

Fork the project and submit a Pull Request (PR)
    Explain what the PR fixes or improves
    Screenshots for bonus points
Use sensible commit messages
    If your PR fixes a separate issue number, include it in the commit message
Use a sensible number of commit messages as well
    e.g. Your PR should not have 100s of commits

How to add yourself to the contributors (give yourself attribution)

Don't forget to give yourself credit! Make sure you add yourself to the contributors list

Common types for this project include: code, doc, translation, review .For full list of contribution types see: https://allcontributors.org/docs/en/emoji-key Steps for updating an existing font

  1. Update original version

  2. Execute basic testing

    Do a basic test to ensure it runs correctly

  3. Update readme

Things to keep in mind

Smaller Pull Requests are likely to be merged more quickly than bigger changes
This project is using Semantic Versioning 2.0.0
Useful Pull Requests will get merged in eventually
    E.g. see how many have already been merged vs. still open

Commit messages

Squashing to 1 commit is not required at this time
Use sensible commit messages (when in doubt: git log)
Use a sensible number of commit messages
If your PR fixes a specific issue number, include it in the commit message: "Fixes XYZ error (fixes #123)"

Code standards Shell Scripts

Follow ShellCheck - A shell script static analysis tool
Try to follow Google's Shell Style Guide

Python

Use 4 spaces for indentation
Consider PEP8 and other (@todo)