Skip to content

Commit bdb00f6

Browse files
committed
add contributing guide, close #12
1 parent 4fdc085 commit bdb00f6

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
How to [code a plugin](https://github.com/netlify/build/blob/master/docs/creating-a-plugin.md)
2+
3+
## Testing and releasing a new version
4+
5+
Try using `beta` branch to release new pre-release versions of the plugin by following [the semantic release guide](https://github.com/semantic-release/semantic-release/blob/master/docs/recipes/pre-releases.md). You can fork and test out new versions published to NPM using the [netlify-plugin-cypress-example](https://github.com/cypress-io/netlify-plugin-cypress-example) repository. Hope the `master` branch merged into `beta` does not bring features and fixes *already released*. Thus I suggest using `beta` branch for new features.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,8 @@ Set environment variable `DEBUG=netlify-plugin-cypress` to see the debug logs. T
141141

142142
## License
143143

144-
This project is licensed under the terms of the [MIT license](/LICENSE.md).
144+
This project is licensed under the terms of the [MIT license](LICENSE.md).
145+
146+
## Contributing
147+
148+
Read the [contributing guide](CONTRIBUTING.md)

0 commit comments

Comments
 (0)