Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (72 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

91 lines (72 loc) · 3.92 KB

Contributing to Onefetch

Note

Please be respectful and constructive in issues, pull requests, and reviews. This project is open source and maintained by volunteers in their free time. Thank you. ❤️

AI Policy

The usage of AI tools is permitted but with human oversight:

  • The human in the loop must understand the code they submit.
  • Any content generated with AI must be reviewed by a human before submission.

Low-quality AI-generated PRs or issues will be closed without review.

Getting started

Follow the instructions for installing onefetch from source.

Adding support for a new language

Adding support for a new Language consists in adding a new entry to language.yaml and filling it in with the right data.

Example:

CSharp: # required, this will be the name of the enum variant for the language as specified by tokei [1]
  type: programming # required, can be programming, data, markup, or prose as specified by linguist [2]
  # required, this is the logo. If it's not within 25x40 bounds, you will get a compiler error. Use `{i}` to color the ascii with `i` the color index.
  ascii: |
    {0}                 ++++++
    {0}              ++++++++++++
    {0}          ++++++++++++++++++++
    {0}       ++++++++++++++++++++++++++
    {0}    ++++++++++++++++++++++++++++++++
    {0} +++++++++++++{3}************{0}+++++++++++++
    {0}+++++++++++{3}******************{0}++++++++{2};;;
    {0}+++++++++{3}**********************{0}++{2};;;;;;;
    {0}++++++++{3}*********{0}++++++{3}******{2};;;;;;;;;;;
    {0}+++++++{3}********{0}++++++++++{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++++++++{2};;;;;;{3}*********{2}::
    {0}+++++++{3}******{0}+++++++{2};;;;;;;;;;{3}**{2};;;{3}**{2};;;
    {0}+++++++{3}*******{0}+++{1}:::::{2};;;;;;;{3}*********{2};;
    {0}+++++++{3}********{1}::::::::::{3}**{2};;;{3}**{2};;;{3}**{2};;;
    {0}++++++++{3}*********{1}::::::{3}******{2};;;;;;;;;;;
    {0}++++++{1}:::{3}**********************{1}::{2};;;;;;;
    {0}+++{1}::::::::{3}******************{1}::::::::{2};;;
    {1} :::::::::::::{3}************{1}:::::::::::::
    {1}    ::::::::::::::::::::::::::::::::
    {1}       ::::::::::::::::::::::::::
    {1}          ::::::::::::::::::::
    {1}              ::::::::::::
    {1}                 ::::::
  colors:
    ansi: # required, a list of the ANSI colors used to colorize the logo
      - blue
      - magenta
      - magenta
      - white
    hex: # optional, alternative to basic colors for terminals that support true colour.
      - "#9B4F97"
      - "#67217A"
      - "#803788"
      - "#FFFFFF"
    chip: "#178600" # required, this is used for the language breakdown bar, its value can be found in linguist [2].
  icon: '\u{E648}' # optional, the UTF-16 code point of the nerd font icon if supported [3]
  serialization: c# # required only if the Enum name `CSharp` doesn't match the display name `C#`

Quality Requirements

  • THE ASCII art must be faithful to the original logo and be easily recognizable, with proper symmetry, clean edges and matching colors.
  • AI or online tools may be used as a base, but the final art must be polished by hand. For inspiration: https://ascii.co.uk/art

Special Thanks to

  • Every onefetch user, who contributed to the project by writing issues or PRs.
  • @spenserblack and @Byron for maintaining this project.
  • Everyone I forgot to mention here, but also influenced onefetch and helped it grow.

❤️❤️

Made with contributors-img.