Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.99 KB

Contributing.md

File metadata and controls

45 lines (27 loc) · 2.99 KB
Raw

Contributing Guidelines

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please take a moment to read the following guidelines before contributing:

⚠️IMPORTANT Note

Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.

Prerequisites ⚠️

  • Open Source Etiquette: If you've never contributed to an open source project before, have a read of Basic etiquette for open source projects.

  • Basic familiarity with Git and GitHub: If you are also new to these tools, visit GitHub for complete beginners for a comprehensive introduction to them.

  • You can read a complete guide on how the complete open source ecosystem works, including the basic flow of contribution in open source.

Found a bug?

  • Ensure the bug was not already reported by searching the existing Issues.
  • If you're unable to find an open issue addressing the problem, open a new one using this bug template. Be sure to include a title and clear description, and as much relevant information as possible.

What should I know before submitting a pull request or issue

We adhere to SemVer 2.0 to the best of our ability.

This workflow is written in TypeScript, a typed variant of JavaScript, and we use Prettier to get a consistent code style.

Because of how GitHub Actions are run, the source code of this project is transpiled from TypeScript into JavaScript. The transpiled code (found in src/) is subsequently compiled using NCC (found in dist/) to avoid having to include the node_modules/ directory in the repository.

Submitting a pull request

ℹ️ Please keep your change as focused as possible.

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm install
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, test it thoroughly. You can write tests to see if all the tests are passing.
  5. Update dist/index.js using npm run build. This creates a single javascript file that is used as an entrypoint for the action
  6. Push to your fork and submit a pull request.

Remarks ✅

  • If something is missing here, or you feel something is not well described, please raise an issue with relevant template.