Skip to content
Permalink
Browse files

Closes #186 - adds contributing guidelines

  • Loading branch information...
codewithkyle committed Aug 2, 2019
1 parent 3968c5b commit 181cae7673aeb6a31100e4ecd15df922b6761d5d
Showing with 54 additions and 6 deletions.
  1. +9 −4 CHANGELOG.md
  2. +26 −0 CONTRIBUTING.md
  3. +2 −2 README.md
  4. +17 −0 build-tools/setup/setup.js
@@ -1,19 +1,24 @@
## 0.2.4 - UNRELEASED
## 0.2.4 - 2019-08-02

### Added

- Adds: updated project setup section of the readme
- Adds: updated IE 11 polyfills to use `nomodule` attribute instead of wrapping the `document.write()` method in a render blocking script
- Adds: papertrain v0.1 documentation
- Adds: papertrain v0.2 documentation
- Adds: contributing guidelines document [#186](https://github.com/Pageworks/papertrain/issues/186)

## 0.2.3 - 2010-07-25
### Fixed

- Fixes: corrects the release date year for the v0.2.x releases

## 0.2.3 - 2019-07-25

### Added

- Adds: SASS watcher build tool [#184](https://github.com/Pageworks/papertrain/pull/184)

## 0.2.2 - 2010-06-21
## 0.2.2 - 2019-06-21

### Added

@@ -32,7 +37,7 @@

- Removes: `.editorconfig` file

## 0.2.1 - 2010-06-17
## 0.2.1 - 2019-06-17

### Added

@@ -0,0 +1,26 @@
# How To Contribute

## Reporting Bugs

1. Ensure the bug was not already reported by checking the [open issues](https://github.com/Pageworks/papertrain/issues)
2. If you're unable to find an open issue addressing the problem [open a new issue](https://github.com/Pageworks/papertrain/issues/new)
3. Provide relevant information about the bug including a title, clear description, and code samples when possible

## Requesting Features

1. Provide a title, clear description, code samples, graphics (flow charts, wireframes, etc), or external references in order to help others understand what you're requesting
2. Actively engage in discussion with others

Once a feature has been researched and discussed a milestone will be assigned. The milestone will determine if the feature will be branched off of the `develop` branch or a long term `wip/` branch.

## Pull Requests

1. Pull the current development branch or the new version you wish to contribute towards
2. Create a new branch using the applicable naming convention:
- `hotfix/branch-name` for bug fixes
- `feature/branch-name` for features
- `wip/papertrain-0.x` for new versions
3. Do the work
4. Commit your changes using the closing issues keyword
- `Closes #XXX - brief description of changes`
4. Submit a PR merging your branch into `develop`
@@ -18,9 +18,9 @@ Papertrain is a framework designed to bring custom utilities and features to Cra
If you are unsure about what version of Papertrain you are using please check the `package.json` file located in the root project directory.
# Feedback
# Contributing
Feel free to [open an issue](https://github.com/Pageworks/papertrain/issues) and report any bugs or request additional features.
Read through our [contributing](https://github.com/Pageworks/papertrain/blob/master/CONTRIBUTING.md) guidelines or feel free to [open an issue](https://github.com/Pageworks/papertrain/issues) and report any bugs or request additional features.
# License
@@ -190,6 +190,23 @@ function cleanupFiles(){
gitignore.stop();
}

const contributing = ora();
contributing.spinner = 'dots';
contributing.text = 'Removing contributing file';
contributing.start();
if(fs.existsSync('./CONTRIBUTING.md')){
fs.unlink('./CONTRIBUTING.md', (err)=>{
if(err){
contributing.text = 'Failed to remove the contributing file';
contributing.fail();
}
contributing.text = 'CONTRIBUTING.md has been removed';
contributing.succeed();
});
}else{
contributing.stop();
}

(async () => {
// Opens the url in the default browser
await open(`http://${ projectDetails.devUrl }/webmaster`);

0 comments on commit 181cae7

Please sign in to comment.
You can’t perform that action at this time.