Skip to content

Commit

Permalink
wip: enable typescript via boundation
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed May 6, 2020
1 parent 1dea2da commit ae42c5e
Show file tree
Hide file tree
Showing 8 changed files with 1,575 additions and 111 deletions.
16 changes: 0 additions & 16 deletions .flowconfig

This file was deleted.

5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 2019 January 26
# 2020 May 5
# https://github.com/bevry/base

# System Files
Expand Down Expand Up @@ -27,6 +27,9 @@ node_modules/
.pnp/
.pnp.js

# -------------------------------------
# CDN Inclusions, Git Exclusions

# Build Outputs
**/out.*
**/*.out.*
Expand Down
6 changes: 4 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# 2019 January 26
# 2020 May 5
# https://github.com/bevry/base

# System Files
**/.DS_Store

# Temp Files
yarn.lock
**/.docpad.db
**/*.log
**/*.cpuprofile
Expand All @@ -32,6 +31,9 @@ node_modules/
.dependabout
.github

# -------------------------------------
# CDN Inclusions, Package Exclusions

# Documentation Files
docs/
guides/
Expand Down
36 changes: 15 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
2019 February 28
2020 March 26
https://github.com/bevry/base
-->

Expand All @@ -9,12 +9,10 @@ https://github.com/bevry/base

We offer support through our [Official Support Channels](https://bevry.me/support). Do not use GitHub Issues for support, your issue will be closed.


## Contribute

Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.


## Development

### Setup
Expand All @@ -25,40 +23,38 @@ Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and s

1. Setup the project for development

``` bash
```bash
npm run our:setup
```


### Developing

1. Compile changes

``` bash
```bash
npm run our:compile
```

1. Run tests

``` bash
```bash
npm test
```


### Publishing

Follow these steps in order to implement your changes/improvements into your desired project:


#### Preparation

1. Make sure your changes are on their own branch that is branched off from master.

1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`

1. Ensure all tests pass:

``` bash
```bash
npm test
```

Expand All @@ -70,7 +66,6 @@ Follow these steps in order to implement your changes/improvements into your des
npm run our:release:prepare
```


#### Pull Request

To send your changes for the project owner to merge in:
Expand All @@ -79,38 +74,37 @@ To send your changes for the project owner to merge in:
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin


#### Publish

To publish your changes as the project owner:

1. Switch to the master branch:

``` bash
```bash
git checkout master
```

1. Merge in the changes of the feature branch (if applicable)

1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:

1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes

1. Add an entry to the changelog following the format of the previous entries, an example of this is:

``` markdown
```markdown
## v6.29.0 2013 April 1
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
```
- Progress on [issue #474](https://github.com/docpad/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/docpad/docpad/issues/165)
- Updated dependencies
```
1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
Expand All @@ -119,6 +113,6 @@ To publish your changes as the project owner:
1. Prepare the release and publish it to npm and git:
``` bash
```bash
npm run our:release
```
5 changes: 5 additions & 0 deletions bin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/usr/bin/env node
'use strict'

/** @type {typeof import("./source/bin.js") } */
module.exports = require('./edition-es2019/bin.js')
Loading

0 comments on commit ae42c5e

Please sign in to comment.