Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 2.58 KB
Raw

Contributing

Contributions are welcome!

Disclaimer: All third party trademarks (including logos and icons) and images referenced by hdl/awesome remain the property of their respective owners. Unless specifically identified as such, hdl/awesome's use of third party trademarks and/or images does not indicate any relationship, sponsorship, or endorsement between the hdl organisation and the owners of these trademarks. All references by hdl/awesome to third party trademarks and/or images are to identify the corresponding third party projects and/or services and intended to constitute nominative fair use under applicable trademark and copyright laws. Please, open an issue or join the chat for discussing trademark and/or copyright issues.

Adding a resource

Most awesome lists are written in a single long Markdown file (see awesome-list). However, in this repository each resource is described in a separate Markdown file (see content/items). The frontmatter is used to provide data about the resource, while the body can contain a long description. The prototype of the frontmatter is shown in template.md.

Further guidelines:

  • Add one resource/file per Pull Request (PR) and explain why it is awesome.
  • Keep descriptions in the frontmatter concise.
  • See list of defined categories in config.yml.
    • Add a new category if needed. If done, a description of the category must be included.
  • Regular chores:
    • Search previous suggestions before making a new one.
    • Check spelling and grammar.
    • Remove any trailing whitespace.
  • An optional logo can be added under static/logos:
    • Size must be between 128x128 and 196x196 pixels (preferred).
    • The logo must be vertical/horizontal centered.
    • Use a white background with roundered corners (10%) if needed.
  • Filenames must be lowercase.

Modifying the site/theme

The website is built with Hugo, using a theme based on Bare Hugo. The theme is a submodule of the main|develop branches. However, at the same time, the customized version is hosted in branch theme of this same repo. Hence, users willing to contribute to the theme need to:

  • Clone this repo recursively, or git submodule update --init --recursive.
  • Change directory to themes/bare-hugo-theme.
  • Make changes, commit them and push a feature branch.
  • Open a pull request against branch theme, NOT main|develop.