Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.5 KB

contributing.md

File metadata and controls

31 lines (20 loc) · 1.5 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding an new Item

Either use the GitHub online editor tool or clone to your local machine. Always create a new branch and PR!

  • Try to fit your item into an existing sections. Open a suggestion to start as discussion about any new sections.
  • Add a new item to the bottom of the list in a section.
  • If a duplicate item exists, discuss why the new item should replace it.
  • Check your spelling & grammar.
  • The item must follow this format: 
    - :legend emoji: [item name](https link) - Description beginning with capital, ending in period.

Valid Sources

Roughly speaking, a source is considered valid if - it could be used by a development team or beginner today on a new Mirth project and not lead them astray.

An item is NOT valid if:

  • it is an archived GitHub (or other) repository
  • it is an outed project that is no longer actively maintained AND it's the type of project that requires maintenance. Eg: minimist is an unmaintained project but it would still qualify as it doesn't particularly require maintenance.

An item can still be VALID if:

  • it is a heavily used project/article (npm downloads being one metric)
  • it is a heavily referenced project/article