janishutz-legacy/impress.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md to match the new repository structure

Browse Source 
Explains the plugins, lib and build.js, etc.

Also delete the contributor guidelines in .github. We won't be using
those going forward, what README.md says is enough.
This commit is contained in:
Henrik Ingo
2017-10-30 19:39:23 +02:00
parent 443a4a82c1
commit 3ef230053e
4 changed files with 55 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
.github/CONTRIBUTING.md vendored
View File

@@ -1,30 +0,0 @@
Issues
------
If you've found a bug or have a great idea for a new feature that will help **all users** of impress.js, let us know by [adding your suggestion]
(https://github.com/bartaz/impress.js/issues/new) to the [issue tracker](https://github.com/bartaz/impress.js/issues).
Guidelines:
* If reporting a bug, please provide a [simplified example](https://sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/).
Pull Requests
-------------
[Pull Requests](https://help.github.com/articles/using-pull-requests/) should be opened against the [master branch]
(https://github.com/bartaz/impress.js/tree/master). But remember that the team will only accept code that fits the purpose of impress.js.
Guidelines:
* If proposing a feature, make sure to discuss that as an issue first.
* Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make.
* Execute `npm run lint && npm test` to make sure the tests pass and the code is consistent with the project standards.
Manual release steps
--------------------
* Bump version in `package.json`
* Bump version in `src/impress.js`
* Create commit with the message "Release version x.x.x"
* Create Github tag and release
* Publish on npm: `git fetch && npm publish ./`

5
.github/ISSUE_TEMPLATE.md vendored
View File

@@ -1,5 +0,0 @@
**Make sure these boxes are checked before submitting your issue, thank you!**
- [ ] I have read and complied with the [Issues Contributing Guidelines](https://github.com/impress/impress.js/blob/master/.github/CONTRIBUTING.md#issues).
- [ ] If am reporting a bug, I have a [simplified example](http://www.sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/) that reproduces the issue.
- [ ] I have used the [Search Tool](https://github.com/impress/impress.js/search) to make sure someone haven't already reported my issue or feature request.

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -1,6 +0,0 @@
**Make sure these boxes are checked before submitting your Pull Request, thank you!**
- [ ] I have read and complied with the [Pull Request Contributing Guidelines](https://github.com/impress/impress.js/blob/master/CONTRIBUTING.md#pull-requests).
- [ ] I checked if an [an issue](https://github.com/impress/impress.js/issues) is necessary for my Pull Request and made sure it exists.
- [ ] I have created a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches).
- [ ] I have used the [Search Tool](https://github.com/impress/impress.js/search?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen&type=Issues) to make sure there are no open Pull Requests fixing the same thing.