Contributing

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

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

git clone https://github.com/github/dependency-submission-toolkit.git
cd dependency-submission-toolkit
npm install

npm run test

Submitting a pull request

Fork and clone the repository
Configure and install the dependencies: npm install
Make sure the tests pass on your machine: npm run test
Create a new branch: git checkout -b my-branch-name
Make your change, add tests, and make sure the tests still pass
Make sure to build and package before pushing: npm run all
Push to your fork and submit a pull request
Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

Write tests.
Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
Write a good commit message.

Update the version number in package.json.
Go to Draft a new release in the Releases page.
Make sure that the Publish this Action to the GitHub Marketplace checkbox is enabled
Click "Choose a tag" and then "Create new tag", where the tag name will be your version prefixed by a v (e.g. v1.2.3).
Use a version number for the release title (e.g. "v1.2.3").
Add your release notes. If this is a major version make sure to include a small description of the biggest changes in the new version.
Click "Publish Release".