MetaMask / MetaMask/contributor-docs

[contributor-docs] Add guide to creating a GitHub action or workflow

Open
#26 1 comment 0 reactions 0 assignees View on GitHub
category-documentation github-migration-triaged team-wallet-framework wf-documentation
Dominant language
JavaScript
Stars
86
Forks
42
PR merge metrics
No merged PRs in 30d

Description

This document should cover best practices that are important to follow in GitHub Actions, such as:
- Providing useful output
- Using secrets for private information (although this could be covered in “Security best practices”)
- Testing GitHub Actions
- Using Shell script vs. JavaScript

Contributor guide

Open the contributing guide

Research direction

Start by locating the contributor documentation structure and any existing guidance on security best practices. Add a guide covering useful output, secrets, testing GitHub Actions, and choosing shell scripts versus JavaScript; done means each requested topic has practical best practices and the guide fits the repository’s documentation style.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript, shell
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.