Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

117 lines (82 loc) · 5.29 KB
Raw

Contribution Guide

You can add a record using any of the following three methods. We have a few methods because this list is displayed both as Markdown on GitHub and on our website.

  • Complete PR
    • add record in README AND
    • add record's yml definition (based on Type of Records) in content folder, in a .md file.
  • Partial PR
    • add record in README OR
    • add record's yml definition (based on Type of Records) in content folder, in a .md file.
  • Addition Request

Note that if you want to send a "Partial PR" you need to check Allow edits from maintainers checkbox while creating the PR, so that we will be able to complete the PR and merge it.

Type of Records

Organization

Create new record file with ./hugow new organizations/<filename>.md, where filename must be lowercase alphanumeric. No special character is allowed except hyphen (-) and underscore (_). It is recommended to use the name of Github organization's account for filename. Then edit the newly created file with your information at:

content/organizations/<filename>.md

---
name: "Foo Org"                                           # (required) alphanumeric with spaces
github: "FooOrg"                                          # (required) github-account-without-spaces
description: "Foo is the coolest org on all the GH"       # (optional)
website: "https://foo.com/"                               # (optional)
---

Any additional content, with Markdown format can go here.

Note: delete the commented sections from the file before committing.

User

Create new record file with ./hugow new users/<filename>.md, where filename must be lowercase alphanumeric. No special character is allowed except hyphen (-) and underscore (_). It is recommended to use the name of Github user's account for filename. Then edit the newly created file with your information at:

content/users/<filename>.md

---
name: "John Doe"                                          # (required) alphanumeric with spaces
github: "john-doe"                                        # (required) github-account-without-spaces
twitter: "johndoe"                                        # (optional) twitter-account-without-spaces
description: "Coolest Dev @ [website](https://foo.com/)"  # (optional)
website: "https://jdoe.io/"                               # (optional)
---

Any additional content, with Markdown format can go here.

Note: delete the commented sections from the file before committing.

Project

Create new record file with ./hugow new projects/<filename>.md, where filename must be lowercase alphanumeric. No special character is allowed except hyphen (-) and underscore (_). It is recommended to use github-account-repository-name for filename. Then edit the newly created file with your information at:

content/projects/<filename>.md

---
name: "foo-org/bar-project"                               # (required) recommended "github-account/repository-name"
link: "https://github.com/foo-org/bar-project"            # (required) full url link to the project
description: "Bar project is the best product ever"       # (optional)
website: "https://bar-project.io/"                        # (optional)
---

Any additional content, with Markdown format can go here.

Note: delete the commented sections from the file before committing.

Incubator, School, Community

Create new record file with ./hugow new incubators/<filename>.md, where filename must be lowercase alphanumeric. No special character is allowed except hyphen (-) and underscore (_). It is recommended to use Github incubator's account for filename. Then edit the newly created file with your information at:

content/incubators/<filename>.md

---
name: "Baz Incubator"                                     # (required) alphanumeric with spaces
github: "Baz-Incubator"                                   # (optional) github-account-without-spaces
description: ""                                           # (optional)
website: ""                                               # (optional)
---

Any additional content, with Markdown format can go here.

Note: delete the commented sections from the file before committing.

Other

Create new record file with ./hugow new other/<filename>.md, where filename must be lowercase alphanumeric. No special character is allowed except hyphen (-) and underscore (_). Then edit the newly created file with your information at:

content/other/<filename>.md

---
name: "Name of entity which isn't any of the above"       # (required) alphanumeric with spaces
description: ""                                           # (optional)
website: ""                                               # (optional)
---

Any additional content, with Markdown format can go here.

Note: delete the commented sections from the file before committing.