Skip to content

Latest commit

 

History

History
executable file
·
56 lines (33 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
56 lines (33 loc) · 2.51 KB
Raw

Contributing

Thank you so much for your interest in contributing!. All types of contributions are encouraged and valued. Please read the CODE of CONDUCT.

Setting Up Your Code

First, fork the repository to your own account and run the following command:

  • Clone your repo: git clone https://github.com/<your_name>/assign-issue-action
  • Change directory to the working dir: cd assign-issue-action
  • Install the dependencies: npm ci

Issue

If you see an open issue you would like to work on, just comment /assign-me and the action will assign the issue to you 😉 Issues that are not assigned are assumed open, and to avoid conflicts, please assign yourself before beginning work on any issues.

Note

Assigned issues that have not had any activity in a week will be unassigned by the action.

Next, use git checkout -b <branch_name> to create a new branch for your work. It's always a good idea to avoid committing changes directly to your master branch - this keeps it clean and avoid some weird issues.

Branch names should be a brief description of your changes, such as fix-typo for fixing a typo.

Important

In order to make git commit messages easier to read and faster to reason about, we follow some guidelines on most commits to keep the format predictable. Check Conventional Commits specification for more information about our guidelines.

Testing

Before creating a PR, run this command: npm run all. It will format, lint, build and test everything.

Pull Request

Push your changes to your forked repository by using git push -u origin <branch_name>.

  • -u tells git to set the upstream, it's the same as --set-upstream
  • origin tells git to push to your fork
  • branch_name tells git to push to a branch - this MUST match the name of the branch you created locally.

Make sure to change the PR title in something like: fix: correct typo or feat: add node latest

Pull Request Reviews

All pull requests require a review before being merged. Most reviews will come from @takanome_dev.

If your pull request is approved, it will be merged.

If your pull request requires additional changes or information, we ask that you apply the changes promptly.

Contributions with outstanding change requests that receive no activity within a week will be closed as stale.

License​

By contributing to this project, you agree that your contributions will be licensed under its MIT LICENSE.