Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

72 lines (56 loc) · 2.84 KB
Raw

Contributing

Getting started

Please check the issues for the latest discussions, questions, and ideas for the Hippocratic License and this site.

What you need to know

If you're new to contributing to projects hosted on Github, or need a refresher, you may find How to make your first pull request on GitHub a useful resource.

Adding your project to the list of adopters

  • Fork the repository.
  • Add a new row to the adopters.csv file, with the project name in the first column, and the project URL in the second column.
  • Open a pull request.

We value your effort and contributions

If your financial or other circumstances are a barrier to your participation in this project, please contact us to discuss the possibility of sponsorship.

Standards and norms

Code of conduct

All participants in this project agree to abide by the terms of our code of conduct, which we strive to enforce with compassion, empathy, safety, and fairness.

Accessibility

Code Style

  • Use spaces for indentation
  • Order properties alphabetically

HTML

  • Include alt attribute for all images
  • Include title attribute for all links
  • Close all your tags properly

CSS

  • Try to use classes instead of IDs unless things are absolutely unique
  • One selector per line
  • Support IE 9 and above
  • Use rem over em or px
  • Maintain contrast to WCAG AA on normal text, WCAG AAA on large text
  • Use colors from this palette

Markdown

You do not need to use smart quotes, em- or en-dashes, etc.; the Markdown processor will handle that.

Building the website for local development

To build the website locally, first install Hugo using your package manager of choice. For example, on Debian/Ubuntu:

apt-get install hugo

If you are using Arch Linux:

pacman -S hugo

If you are using Homebrew on macOS:

brew install hugo

Start the server

From the repository's root directory, start the development server:

hugo server -D