CONTRIBUTING.md

Contributing to Phantom

Thank you for taking the first step in contributing to Phantom!

Please follow the workflow below to ensure your contribution is reviewed.

⚠️ Before contributing code, be sure to associate your work with an existing issue, or create your own.

Instructions

0 Mind the Code of Conduct
1 Fork the repo on GitHub
2 Clone the project to your machine
3 Install dependencies with npm i
4 Create a new-feature or bug-fix branch

git checkout -b your-branch

5 Commit your updates to your branch.

git add my-changed-file.js
git commit -m "My commit message"

6 Push your work to your-branch.

git push -u your-branch

Only use the -u flag the first time you push. This will publish your local branch to your remote, and only needs to be done once.

7 Make a Pull request on GitHub from your-branch against Phantom's dev branch

sidiousvic:dev ← yourUsername:yourBranch

8 Make yourself a piña colada 🍍 while you wait for your changes to be reviewed

Making Pull Requests

• Make sure you are making a pull request against the dev branch. PRs against production will not be considered.
• Make sure you are requesting to pull a feature or bug-fix branch. Don't request your fork's master branch.
• Please complete the PR template that appears before submitting your PR.

Issues

• Please label your issue properly.
• Be as descriptive as possible. What's wrong? What error messages (if any) did you have? What do you want to change? What's the user story?
• Please complete the issue template.

Checks

The following checks are currently running in the Phantom repository.

Build ^{on:push:branches:[production]}

Builds the package using Typescript, runs tests from src/.

Publish ^{on:release:types:[created]}

Publishes the @sidiousvic/phantom package to npm and GitHub Packages.

Kermitoid ^{on:pull_request:branches:*}

Runs Kermitoid, our resident amphibian bot, on PRs for the Phantom repo. Only for Phantom collaborators.

Thanks for contributing! 👻