Merge pull request #33 from github/updating-contrib-flow

Adding a contributor's guide

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing
+
+[fork]: https://github.com/github/dependency-submission-toolkit/fork
+[pr]: https://github.com/github/dependency-submission-toolkit/compare
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+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](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
+to the public under the [project's open source license](LICENSE).
+
+Please note that this project is released with a [Contributor Code of
+Conduct][code-of-conduct]. By participating in this project you agree
+to abide by its terms.
+
+### Bootstrapping the project
+
+```
+git clone https://github.com/github/dependency-submission-toolkit.git
+cd dependency-submission-toolkit
+npm install
+```
+
+### Running the tests
+
+```
+npm run test
+```
+
+## Submitting a pull request
+
+0. [Fork][fork] and clone the repository
+1. Configure and install the dependencies: `npm install`
+2. Make sure the tests pass on your machine: `npm run test`
+3. Create a new branch: `git checkout -b my-branch-name`
+4. Make your change, add tests, and make sure the tests still pass
+5. Make sure to build and package before pushing: `npm run all`
+6. Push to your fork and [submit a pull request][pr]
+7. 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](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Cutting a new release
+
+1. Update the version number in [package.json](https://github.com/github/dependency-submission-toolkit/blob/main/package.json).
+1. Go to [Draft a new
+   release](https://github.com/github/dependency-submission-toolkit/releases/new)
+   in the Releases page.
+1. Make sure that the `Publish this Action to the GitHub Marketplace`
+   checkbox is enabled
+3. 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`).
+4. Use a version number for the release title (e.g. "v1.2.3").
+5. 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.
+6. Click "Publish Release".
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@github/dependency-submission-toolkit",
-  "version": "1.2.4",
+  "version": "1.2.7",
   "description": "A TypeScript library for creating dependency snapshots.",
   "prepare": "npm run build",
   "main": "dist/index.js",