Permalink
Browse files

Fixed typos, added some minor changes in contributing guide

  • Loading branch information...
mrbean-bremen committed Dec 28, 2017
1 parent 7677770 commit 6f208a98decc31ec7a41b22039fbed5e60849636
Showing with 21 additions and 15 deletions.
  1. +21 −15 CONTRIBUTING.md
View
@@ -2,7 +2,7 @@
# Contributing to pyfakefs
We welcome any contributions that help to improve pyfakefs for the community.
This may include bug reports, bug fixes, new features, infrastructure enhancements, or
Contributions may include bug reports, bug fixes, new features, infrastructure enhancements, or
documentation updates.
## How to contribute
@@ -11,40 +11,46 @@ documentation updates.
If you think you found a bug in pyfakefs, you can [create an issue](https://help.github.com/articles/creating-an-issue/).
Before filing the bug, please check, if it still exists in the [master branch](https://github.com/jmcgeheeiv/pyfakefs).
If you can reproduce the problem, please provide enough information to reproduce the problem.
If you can reproduce the problem, please provide enough information so that it can be reproduced by other developers.
This includes:
* The Operating System
* The Python version
* A minimal example to reproduce the problem (preferably in the form of a failing test, if possible)
* The stack trace in case of an unexpected excpetion
For better readabilty, you may use [markdown code formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for any included code.
* A minimal example to reproduce the problem (preferably in the form of a failing test)
* The stack trace in case of an unexpected exception.
For better readability, you may use [markdown code formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for any included code.
### Proposing Enhancements
If you need a specific feature that is not implemented, or have an idea for the next
exciting enhancement in pyfakefs, you can also create a respective issue. The best chances
to get it are of course if you implement it yourself, as described in the next item.
exciting gimmick in pyfakefs, you can also create a respective issue.
Of course - implementing it yourself is the best chance to get it done!
The next item has some information on doing this.
### Contributing Code
The preferred workflow for contributing code is to [fork](https://help.github.com/articles/fork-a-repo/) the
[repository](https://github.com/jmcgeheeiv/pyfakefs) on GitHub, clone,
develop on a feature branch, and [create a pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork).
The preferred workflow for contributing code is to
[fork](https://help.github.com/articles/fork-a-repo/) the [repository](https://github.com/jmcgeheeiv/pyfakefs) on GitHub, clone it,
develop on a feature branch, and [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork) when done.
There are a few things to consider for contributing code:
* Please use the standard [PEP-8 coding style](https://www.python.org/dev/peps/pep-0008/)
(your IDE or tools like [pep8](https://pypi.python.org/pypi/pep8) or [pylint](https://pypi.python.org/pypi/pylint) will help you)
* Use the [Google documentation style](https://google.github.io/styleguide/pyguide.html) to document new public classes or methods
* Provide unit tests for bug fixes or new functionality - check the existing tests for examples
* Provide meaningful commit messages
* Provide meaningful commit messages - it is ok to amend the commits to improve the comments
* Check that the automatic tests on [Travis](https://travis-ci.org/jmcgeheeiv/pyfakefs)
and [AppVeyor](https://ci.appveyor.com/project/jmcgeheeiv/pyfakefs) all pass for your pull request
* Be ready to adapt your changes after a code review
### Contributing Documentation
If you want to improve the existing documentation, you can just create a pull request with the changes.
If you want to improve the existing documentation, you can do this also using a pull request.
You can contribute to:
* the source code documentation using [Google documentation style](https://google.github.io/styleguide/pyguide.html)
* the [README](https://github.com/jmcgeheeiv/pyfakefs/blob/master/README.md)
* the documentation published on [GitHub Pages](http://jmcgeheeiv.github.io/pyfakefs/), located in the 'docs' directory.
* the [README](https://github.com/jmcgeheeiv/pyfakefs/blob/master/README.md) using [markdown syntax](https://help.github.com/articles/basic-writing-and-formatting-syntax/)
* the documentation published on [GitHub Pages](http://jmcgeheeiv.github.io/pyfakefs/),
located in the `docs` directory.
For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/).
* [this file](https://github.com/jmcgeheeiv/pyfakefs/blob/master/CONTRIBUTING.md) if you want to enhance the contributing guide itself
* [this file](https://github.com/jmcgeheeiv/pyfakefs/blob/master/CONTRIBUTING.md)
if you want to enhance the contributing guide itself
Thanks for taking the time to contribute to pyfakefs!

0 comments on commit 6f208a9

Please sign in to comment.