From 94ba1820aab402d2f932a6a71660ef66d36e97db Mon Sep 17 00:00:00 2001 From: Jeremy Overman Date: Mon, 23 Oct 2017 22:15:22 -0400 Subject: [PATCH 1/3] New: Issue 8 add contributing docs (#11) * Added contributing docs and the docs release rule * Added example of branch message --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 6 ++++++ 2 files changed, 58 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..06a2034 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing + +Contributing is always welcome! If you see something in the issues for the project and would like to take a stab at it, give it a shot and put in a pull request and it'll be looked at as soon as possible. + +If you find an issue with the project, please submit an issue with the version of the package that you currently have: + +`npm view action-runner version` + +And the verison of node that you are running: + +`node -v` + +Along with any other useful information such as error messages/codes, operating system, environment, steps to recreate, etc. + +Feature requests are also more than welcome! + +## Branching + +All branches should be made off of the develop branch unless specifically release related. Once you are finished with your branch, you must submit a pull request to be reviewed, and if successful, it will be merged back into develop. + +Branches should include the issue number they are related to. We will not accept any pull requests that are not tied to an underlying issue. Branches should follow the follow scheme: + +`issue-#-short-description-of-branch` + +Once we are ready to release the new package, we will then merge develop into master, and our test suite will be run and, if successful, a new release will be made + +## Commits + +We will be following the following commit scheme: + +| Message | Release Type | Description | +|----------|--------------|-----------------------------------------------| +| Breaking | Major | Changes that break the current implementation | +| Fix | Minor | Bug fixes | +| Update | Minor | Updating features of the application | +| New | Minor | Creating new features for the application | + +When you create your branch, feel free to commit as often as you like with whatever commit messages you see fit on your branch. When you submit your pull request and it is approved, the merger will squash your commits into a single commit with the correct message and merge it in. + +## Compiling + +This project uses typescript, and files must be compiled before they can be run. To install typescript on your machine, you can run the command `npm install typescript -g`, and once installed you can compile by running the command `tsc`, or you may run `tsc -w` to watch for changes and compile of file change. + +## Tests + +All pull requests should have appropriate tests associated with it unless specific valid reasoning is given why there should be no tests. All tests should be added in the appropriate files under `/src/spec` and all tests must pass for a pull request to be merged. + +You can run the tests using the command `npm test` and run the test and view coverage information with `npm run coverage`. + +## Thank you + +All issues, ideas, comments, and pull requests are greatly appreciated! I'm excited to see what the GitHub community can do for action-runner, and I truly look forward to working with you all! \ No newline at end of file diff --git a/package.json b/package.json index 598880a..394d4c2 100644 --- a/package.json +++ b/package.json @@ -21,6 +21,12 @@ "release": { "verifyConditions": { "path": "./verifyConditions.js" + }, + "analyzeCommits": { + "preset": "ESLint", + "releaseRules": [ + { "type": "docs", "release": "patch" } + ] } }, "nyc": { From 0cf9fac109f06713a8f9856e9d32b90fd38e338c Mon Sep 17 00:00:00 2001 From: Jeremy Overman Date: Mon, 23 Oct 2017 22:25:26 -0400 Subject: [PATCH 2/3] New: Issue 8 add contributing docs (#12) * Added contributing docs and the docs release rule * Added example of branch message * Removed the preset from package.json --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index 394d4c2..63a5d11 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,6 @@ "path": "./verifyConditions.js" }, "analyzeCommits": { - "preset": "ESLint", "releaseRules": [ { "type": "docs", "release": "patch" } ] From fa65ab005e1b7a1ffb1c4a179f84f0a141aba807 Mon Sep 17 00:00:00 2001 From: Jeremy Overman Date: Mon, 23 Oct 2017 22:58:06 -0400 Subject: [PATCH 3/3] fix: Issue 8 updating branching md (#14) * Merge develop into master (#13) * New: Issue 8 add contributing docs (#11) * Added contributing docs and the docs release rule * Added example of branch message * New: Issue 8 add contributing docs (#12) * Added contributing docs and the docs release rule * Added example of branch message * Removed the preset from package.json * Merge develop into master (#13) * feat: Issue 8 add contributing docs (#11) * Added contributing docs and the docs release rule * Added example of branch message * featu: Issue 8 add contributing docs (#12) * Added contributing docs and the docs release rule * Added example of branch message * Removed the preset from package.json * Updated the branching and contributing files * Added link to contributing page to readme --- BRANCHING.md | 35 +++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 13 ------------- readme.md | 6 +++++- 3 files changed, 40 insertions(+), 14 deletions(-) create mode 100644 BRANCHING.md diff --git a/BRANCHING.md b/BRANCHING.md new file mode 100644 index 0000000..63f8964 --- /dev/null +++ b/BRANCHING.md @@ -0,0 +1,35 @@ +# Branching + +An overview of how this project handles branching. + +## Feature branch + +When a contributor wishes to make a change on the repository, they must first checkout develop, pull the latest version, then create a feature branch from develop. + +The branch name should look something like this: + +`issue-8-short-description-of-change` + +If there is an issue on the latest production branch, we may create a branch off of master. + +## Pull Request + +Once the feature branch is complete, a pull request must be made to the appropriate branch -- develop for a feature, or master for a hotpatch. + +The pull request must pass the Semaphore build before being merged in. When mergeing, the commit message must follow the following conventions: + +| Message | Release Type | Description | +|----------|--------------|-----------------------------------------------| +| feat | Minor | A new feature being added to the application | +| fix | Patch | A bug fix | +| perf | Patch | A performance issue fix | + +The commit message must look like this: + +`message: a short description (issue-#)` + +## Deployment + +When we are ready to cut a release for deployment, we must checkout the master branch, merge develop into master, then push master to origin. + +This will kick off the Semaphore build and, if successful, will create a new release and publish to the NPMJS Registry for us. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06a2034..3f85d80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,19 +24,6 @@ Branches should include the issue number they are related to. We will not accept Once we are ready to release the new package, we will then merge develop into master, and our test suite will be run and, if successful, a new release will be made -## Commits - -We will be following the following commit scheme: - -| Message | Release Type | Description | -|----------|--------------|-----------------------------------------------| -| Breaking | Major | Changes that break the current implementation | -| Fix | Minor | Bug fixes | -| Update | Minor | Updating features of the application | -| New | Minor | Creating new features for the application | - -When you create your branch, feel free to commit as often as you like with whatever commit messages you see fit on your branch. When you submit your pull request and it is approved, the merger will squash your commits into a single commit with the correct message and merge it in. - ## Compiling This project uses typescript, and files must be compiled before they can be run. To install typescript on your machine, you can run the command `npm install typescript -g`, and once installed you can compile by running the command `tsc`, or you may run `tsc -w` to watch for changes and compile of file change. diff --git a/readme.md b/readme.md index d2a3e48..9abcb72 100644 --- a/readme.md +++ b/readme.md @@ -227,4 +227,8 @@ If an `arg` that is required is not passed into the command chain, a usage help Usage: template template [otherarg] template The name of the template to generate - otherarg Another optional argument \ No newline at end of file + otherarg Another optional argument + +# Contributing + +We welcome contributors to open issues or submit pull requests. Please check out our [contributing page](https://github.com/jeremyoverman/action-runner/blob/develop/CONTRIBUTING.md) for more information. \ No newline at end of file