Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.89 KB

Contributing to this GitHub Action

Simple Icons welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines below. If you decide to contribute anything, please do the following:

  1. Fork this repository
  2. Create a new branch from the latest master (read more here)
  3. Start hacking on the new branch
  4. Commit and push to the new branch
  5. Make a pull request

Also consider the following, this Action is tailor-made for Simple Icons and changes should always be made with that in mind. If you wish to implement significant changes you are perhaps better off forking this repository.

Guidelines

Please note that modifications should follow these coding guidelines:

  • Indent is 2 spaces
  • Use async/await over Promises and callbacks

Building

We use @vercel/ncc to create a single .js file that contains all the source code needed to run the Action. This means that this file works without the node_modules/ folder present.

Therefore, you should make sure the npm run build command does not fail due to your changes. Run npm run build before making a commit and include the changes in the ./lib folder in your commit.

Local Preview

Use this command below to preview the release note:

SI_REPOSITORY_TOKEN='your-repo-token' npm run preview

Release

  1. Update the version field in package.json
  2. Run npm install to apply all package.json changes to package-lock.json
  3. Create a commit to master branch with the Release v{major}.{minor}.{patch} commit message, and push the commit
  4. Create a release on the latest commit, the release tag should be v{major}.{minor}.{patch}
  5. Switch to the v{major} branch, rebase the master branch to v{major} branch, and push to the remote