Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

49 lines (39 loc) · 1.78 KB
Raw

Contributing Guidelines

The maintainers of asdf-yamllint welcome contributions and corrections. This includes improvements to the documentation or code base, tests, bug fixes, and implementations of new features. We recommend you open an issue before making any substantial changes so you can be sure your work won't be rejected. But for small changes, such as fixing a typo, you can open a Pull Request directly.

If you decide to make a contribution, please use the following workflow:

  • Fork the repository.
  • Create a new branch from the latest main.
  • Make your changes on the new branch.
  • Commit to the new branch and push the commit(s).
  • Open a Pull Request against main.

Security

For security related issues, please refer to the security policy.

Prerequisites

To be able to contribute you need the following tooling:

  • Git;
  • Make;
  • asdf;
  • (Recommended) a code editor with EditorConfig support;
  • (Recommended) Python v3;
  • (Optional) actionlint (see .tool-versions for preferred version);
  • (Optional) Docker or Podman (development environment available)
  • (Optional) hadolint (see .tool-versions for preferred version);
  • (Optional) ShellCheck (see .tool-versions for preferred version);
  • (Optional) shfmt (see .tool-versions for preferred version);