CONTRIBUTING.md

Contributing guide

Prerequisites

Visual Studio Code

• common extensions

• YAML:

  • YAML (linter, formatter, intellisence, snippets)
    If you prefer GitHub Actions extension over this one, it's possible to disable YAML extension for workflow files via:

    {
      "yaml.schemas": {
        "schemas/empty.json": ".github/workflows/*.yaml"
      }
    }

    where empty.json is a schema with:

    {}

    content.

• Hugo:

  • Hugo Language and Syntax Support (snippets, highlighting)

How to get started?

Before writing your own pages try to explore existing ones with preinstalled prerequisites. Start with the simplest one.

How to add a repository to the home page?

Public repositories are not listed automatically based on our organization. It's manually chosen what to show and what not. To add a new repository to the repository list:

• Open data/repositories.yaml file

• Add a new array item like:

  cli-pages: # A repository
    description: Command Line Interface (CLI) pages

How to add a similar project to the project page?

To add a new similar project to the project list:

• Open data/projects.yaml file

• Add a new array item like:

  eg: # A similar project
    description: Useful examples at the command line
    url: https://github.com/srsudar/eg

How to add a common extension to the extension page?

To add a new common extension to the extension list:

• Open data/extensions.yaml file

• Add a new object like:

  Commit messages: # An extension category
    commitlint: # A common extension
      description: A VS Code extension that integrates commitlint
      url: https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint
      type: [linter]

How to add a common editor to the editor page?

To add a new common editor to the editor list:

• Open data/editors.yaml file

• Add a new object like:

  Krita: # An editor
    description: Free and open-source raster graphics editor.
    url: https://krita.org/en/

How to add a project supporting this one to the supported by list?

To add a new common editor to the editor list:

• Open data/support.yaml file

• Add a new object like:

  Cheatsheets: # A project
    introduction_url: https://github.com/rstacruz/cheatsheets/pull/1953
    mention_url: https://github.com/rstacruz/cheatsheets/pull/1961

How else can I help?

Now we don't have anybody in organization who understands HTML, CSS and JavaScript and willing to close opened issues related to these languages. If you are an open-source contributor and want to help us, go ahead and make PR. 😄

Thanks!

See also

• Mike Dane: Hugo tutorials