Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.2 KB

pull_request_template.md

File metadata and controls

42 lines (32 loc) · 2.2 KB

Thank you for your contribution to the awesome-hackernews repository. 👍
Before submitting this PR, please make sure the following conditions are met (please tick the relevant boxes):

  • ⅰ. The pull request concerns only one project1.

  • ⅱ. This project is classified as FOSS.

  • ⅲ. The pull request title is "Add <xxx> to <yyy>", which means adding project <xxx> to section <yyy>.2

    Examples:

    • "Add My Project to Embeddables"
    • "Add My Project to Libraries/Python", for nested sections

  • ⅳ. Your addition satisfies one of the following formats3:

    • If the project has a homepage (different from where the source code is hosted): 
      - [Name](http://homepage/) - Short description. ([Source Code](http://url.of/source/code)) `License`
    • Else: 
      - [Name](http://url.of/source/code) - Short description. `License`

    Guidelines about the description:

    • Avoid redundancy
    • Keep it short
    • End with '.'

  • ⅴ. Your addition is inserted in alphabetical order in the list (case-insensitive).

  • ⅵ. You have searched the repository for any relevant issues or PRs, including closed ones.

If you have any questions or would like to provide more information regarding your PR, please use the comments section below.

1: If you want to submit multiple projects, please open one PR per project.
2: If the project does not fit into an already existing section, i.e. a new one must be created, do not hesitate to create it. In this case, don't forget to update the TOC and put the "back to top" link.
3: scripts/format_entry.sh can be invoked to help you.

A custom linter is automatically invoked through GitHub actions. You are responsible of correcting any errors that are detected.

NB: If you are a first time contributor, you will have to wait for a maintainer to approve GitHub actions (a.k.a. the linter) to run.