From 1e82e14eed59e3b1a8cb6eaafa9800b1cd084ed9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Estev=C3=A3o=20Soares=20dos=20Santos?= Date: Sat, 16 May 2015 00:09:24 +0100 Subject: [PATCH] docs(README.md): update documentation and credits --- CREDITS.md | 14 +++++---- README.md | 91 +++++++++++++++++++++++++++++++----------------------- 2 files changed, 61 insertions(+), 44 deletions(-) diff --git a/CREDITS.md b/CREDITS.md index a94c47d..135eb57 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,12 +1,12 @@ Credits ======= - - Showdown v2 - * [Estevão Santos](http://soares-dos-santos.com) + - Showdown v1 + * [Estevão Santos](https://github.com/tivie) * [Pascal Deschênes](https://github.com/pdeschen) - - Showdown v1 + - Showdown v0 * [Corey Innis](http://github.com/coreyti):
- GitHub project maintainer + Original GitHub project maintainer * [Remy Sharp](https://github.com/remy/):
CommonJS-compatibility and more * [Konstantin Käfer](https://github.com/kkaefer/):
@@ -29,8 +29,10 @@ Credits WebKit bugfix * [Pascal Deschênes](https://github.com/pdeschen):
Grunt support, extension fixes + additions, packaging improvements, documentation - * [Estevão Santos](http://soares-dos-santos.com)
- Bug fixing and later maintainer + * [Estevão Santos](https://github.com/tivie)
+ Bug fixing and late maintainer + * [Hannah Wolfe](https://github.com/ErisDS)
+ Bug fixes - Original Project * [John Gruber](http://daringfireball.net/projects/markdown/)
diff --git a/README.md b/README.md index 699b904..a26d7c9 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,11 @@ Both examples should output...

hello, markdown!

``` +## Integration with AngularJS + +ShowdownJS project also provides seamlessly integration with AngularJS via a "plugin". +Please visit https://github.com/showdownjs/ngShowdown for more information. + ## Extensions @@ -252,47 +257,57 @@ Second, client-side extensions should add a property onto `Showdown.extensions` ### Testing Extensions -The showdown test runner is setup to automatically test cases for extensions. To add test cases for an extension, create a new folder under `./test/extensions` which matches the name of the `.js` file in `./src/extensions`. Place any test cases into the folder using the md/html format and they will automatically be run when tests are run. +The showdown test runner is setup to automatically test cases for extensions. To add test cases for an extension, +create a new folder under `./test/extensions` which matches the name of the `.js` file in `./src/extensions`. +Place any test cases into the folder using the md/html format and they will automatically be run when tests are run. ## Contributing -The organization needs members to maintain Showdown. + +If you wish to contribute please read the following quick guide. + +### Want a Feature? +You can request a new feature by submitting an issue. If you would like to implement a new feature feel free to issue a +Pull Request. + + +### Pull requests (PRs) +PRs are awesome. However, before you submit your pull request consider the following guidelines: + + - Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. + - When issuing PRs that change code, make your changes in a new git branch based on master: + + ```bash + git checkout -b my-fix-branch master + ``` + + - Documentation (i.e: README.md) changes can be made directly against master. + - Run the full test suite before submitting and make sure all tests pass (obviously =P). + - Try to follow our [**coding style rules**](https://github.com/showdownjs/code-style/blob/master/README.md). + Breaking them prevents the PR to pass the tests. + - Refrain from fixing multiple issues in the same pull request. It's preferable to open multiple small PRs instead of one + hard to review big one. + - If the PR introduces a new feature or fixes an issue, please add the appropriate test case. + - We use commit notes to generate the changelog. It's extremely helpful if your commit messages adhere to the + [**AngularJS Git Commit Guidelines**](https://github.com/showdownjs/code-style/blob/master/README.md#commit-message-convention). + - If we suggest changes then: + - Make the required updates. + - Re-run the Angular test suite to ensure tests are still passing. + - Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```bash + git rebase master -i + git push origin my-fix-branch -f + ``` + - After your pull request is merged, you can safely delete your branch. + +If you have time to contribute to this project, we feel obliged that you get credit for it. +These rules enable us to review your PR faster and will give you appropriate credit in your GitHub profile. +We thank you in advance for your contribution! + +### Joining the team +We're looking for members to help maintaining Showdown. Please see [this issue](https://github.com/showdownjs/showdown/issues/114) to express interest or comment on this note. - ## Credits - - - Showdown - * [Estevão Santos](http://soares-dos-santos.com):
- GitHub project maintainer - * [Pascal Deschênes](https://github.com/pdeschen):
- Grunt support, extension fixes + additions, packaging improvements, documentation - * [Corey Innis](http://github.com/coreyti):
- Original GitHub project maintainer - * [Remy Sharp](https://github.com/remy/):
- CommonJS-compatibility and more - * [Konstantin Käfer](https://github.com/kkaefer/):
- CommonJS packaging - * [Roger Braun](https://github.com/rogerbraun):
- Github-style code blocks - * [Dominic Tarr](https://github.com/dominictarr):
- Documentation - * [Cat Chen](https://github.com/CatChen):
- Export fix - * [Titus Stone](https://github.com/tstone):
- Mocha tests, extension mechanism, and bug fixes - * [Rob Sutherland](https://github.com/roberocity):
- The idea that lead to extensions - * [Pavel Lang](https://github.com/langpavel):
- Code cleanup - * [Ben Combee](https://github.com/unwiredben):
- Regex optimization - * [Adam Backstrom](https://github.com/abackstrom):
- WebKit bugfix - - - - Original Project - * [John Gruber](http://daringfireball.net/projects/markdown/)
- Author of Markdown - * [John Fraser](http://attacklab.net/)
- Author of Showdown +Full credit list at https://github.com/showdownjs/showdown/blob/master/CREDITS.md