Permalink
Browse files

Update contributor guide

  • Loading branch information...
thekingnothing committed Jun 16, 2017
1 parent b082202 commit ec9f520a0f09a16426ca5d6cd7ca13a08f24dd0b
Showing with 18 additions and 6 deletions.
  1. +12 −6 {.github → }/CONTRIBUTING.md
  2. +6 −0 README.md
@@ -1,19 +1,25 @@
# Contributing to PowerMock #
First of all, thank you for considering contributing to PowerMock. Please, read the guideline before start. Following these guidelines helps to communicate that you respect the time of the developers managing and developing PowerMock.
## Content ##
* [If looking for support](#if-looking-for-support)
* [Pull request criteria](#pull-request-criteria)
* [General info](#general-info)
* [More on pull requests](#more-on-pull-requests)
## If looking for support ##
Search / Ask question on [stackoverflow](https://stackoverflow.com/questions/tagged/powermock)
Go to the PowerMock [mailing-list](https://groups.google.com/forum/#!forum/powermock/) (moderated)
Issues should always have a [Short, Self Contained, Correct (Compilable)](http://sscce.org), Example (same as any question on stackoverflow.com)
## Content ##
* [Pull request criteria](#pull-request-criteria)
## Pull request criteria ##
* At least one commit message in the PR starts with Fixes #id : where id is an [issue tracker](https://github.com/powermock/powermock/issues) id. This allows track release notes. Also GitHub will track the issue and [close it](https://github.com/blog/1386-closing-issues-via-commit-messages) when the PR is merged.
* Use @since tags for new public APIs
* Use `@since` tags for new public APIs
* Include tests
@@ -62,4 +68,4 @@ Fixes #777 : Refactors this part of PowerMock to make feature possible
* Documentation !!! Always document with love the public API. Internals could use some love too. In all cases the code should _auto-document_ itself like any [well designed API](rebased and squashed if necessary, so that each commit clearly changes one things and there are no extraneous fix-ups).
* We use (4) spaces instead of tabs. Make sure line ending is Unix style (LF). More on line ending on the [Github help](https://help.github.com/articles/dealing-with-line-endings/).
* We use (4) spaces instead of tabs. Make sure line ending is Unix style (LF). More on line ending on the [Github help](https://help.github.com/articles/dealing-with-line-endings/).
View
@@ -50,6 +50,12 @@ Please note that PowerMock is mainly intended for people with expert knowledge i
## Support and discussion
Join the mailing-list [here](http://groups.google.com/group/powermock) for questions, feedback and support.
## For new contributors
# Contributing to PowerMock #
First of all, thank you for considering contributing to PowerMock. Please, read [the guideline](CONTRIBUTING.md) for a new contributor before start.
## Links
* [Change log](https://raw.githubusercontent.com/powermock/powermock/master/changelog.txt)
* [Mailing list for questions and support](http://groups.google.com/group/powermock)

0 comments on commit ec9f520

Please sign in to comment.