Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

91 lines (59 loc) · 3.98 KB
Raw

Contribution guidelines

Contributions and suggestions are always welcome!

Conduct

This project uses the Contributor Covenant Code of Conduct. Please see the full text for more information, including for methods to report violations.

Inclusion criteria

If you want an item to be added to the list, it must:

  1. Be awesome. This is deliberately vague; you get to decide what's awesome.
  1. Be relevant to ComputerCraft. It could be an awesome ComputerCraft extension mod, or an awesome tutorial. It cannot be your friend's cat's Facebook page, or good ol' Neighbor Joe's JavaScript autocorrection tool.
  1. Can be immediately used. It has to have an installation script, or (in the case of literature) be immediately readable.
  2. Have a public URL somewhere. People reading the list should be able to get to your addition easily. A Pastebin link is sufficient. Exception: No links that require you to sign in. This includes Discord forum posts.

If you have any questions about these guidelines, feel free to join Tomodachi Labs' Discord server or send Tomodachi94 a message on Matrix.

Document styling

Added items should be in alphabetical order, with some exceptions:

  • The ComputerCraft Mods subsection is sorted manually, to keep the modern mods on top and the legacy mods at the bottom.
  • The Resources section is sorted manually, from preferred resources to avoided resources.

List entries

For all list items, follow this format:

- [My Awesome Thing](https://example.com) - An awesome thing for ComputerCraft.

The attached link should be the best link available. Prefer homepages to Pastebin uploads.

All list items should end in a period. List items should start with -.

Table of contents

The table of contents is updated by the DocToc tool.

Reorganization of the list

PRs doing a major refactor of the list will generally not be accepted.

Spelling

Please use American spelling unless it is a part of a name. Please keep item descriptions short, and end them with a period. Avoid sounding like an advertisement.

Automated checks

Various checks are executed with GitHub Actions for quality assurance:

  • The awesome-lint project is executed to ensure that the standards set by the upstream Awesome list are upheld.
  • The Lychee link checker is executed to ensure that all links in the repository are valid.
  • The Vale prose linter is executed to ensure a consistent style in the repository.
  • The DocToc tool is executed, and the pipeline fails if changes are not committed.

To run the checks locally, you can install the tools manually (not recommended), or use this workflow:

Commits

Commits should do one thing, or a series of related things.

Commit messages should be written in the present tense, with natural capitalization and no periods:

Add <item> and <item>
Add <section>
Fix [typo|dead link|<error type>]

However, do what makes the most sense.

Repository settings

Repository settings (such as the repository's labels, description, and even its name) can be changed by submitting a PR to the .github/settings.yml file. Contributions are encouraged if you think these things could be improved.

For a list of valid options, please see its documentation