Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.71 KB

Contributing guidelines

🎉 First off, thank you for taking the time to contribute!

The following is a set of guidelines for contributing to this project. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table of Contents

What should I know to get started?

Please check out README.md file to get a summary of the project and how to setup the environment.

How can I contribute?

I want to add a new list

This section guides you through submitting a completely new list of resources. Please check that the list doesn't fall under any existing ones to prevent duplicates. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

  1. Create a new page using the command hugo new [slug].md
  2. Update the title, description and relevant keywords in the front matter
  3. Create resource table with appropriate columns and links
  4. Set draft: false when list is ready to publish

Note: Tables should be sorted alphabetically by the first column

I want to update an existing list

This section guides you through updating an existing list of resources. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

If you want to update the description or add a new item to an existing list, please submit your changes as a pull request.

Submitting a pull request (PR)

Please follow these steps to have your contribution considered:

  1. Follow all instructions of the pull request template
  2. Follow the styleguides
  3. Verify that all status checks are passing

Styleguides

Content Styleguide

  • Use title case for content titles
  • End all sentences with a period
  • Use American spellings of words

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Start the commit message with the appropriate commit type