diff options
author | mrbean-bremen <hansemrbean@googlemail.com> | 2022-10-07 19:45:47 +0200 |
---|---|---|
committer | mrbean-bremen <mrbean-bremen@users.noreply.github.com> | 2022-10-08 08:35:04 +0200 |
commit | 7e2e60d6ac0e11504b17cb5b6d4061a2a8397fb6 (patch) | |
tree | dc8e1026f5961235075cd14d21f70e23414ca863 /CONTRIBUTING.md | |
parent | 28fbf1cefa221607c84c744bb6b669b25f87444d (diff) | |
download | pyfakefs-7e2e60d6ac0e11504b17cb5b6d4061a2a8397fb6.tar.gz |
Update documentation after transfer to pytest-dev
- also adapt after renaming master to main branch
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d2daf5..bac4964 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ documentation updates. ### Reporting Bugs 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). +Before filing the bug, please check, if it still exists in the [main branch](https://github.com/pytest-dev/pyfakefs). If you can reproduce the problem, please provide enough information so that it can be reproduced by other developers. This includes: * The Operating System @@ -29,7 +29,7 @@ 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 it, +[fork](https://help.github.com/articles/fork-a-repo/) the [repository](https://github.com/pytest-dev/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/) @@ -37,8 +37,7 @@ There are a few things to consider for contributing code: * 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 - 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 + * Check that the automatic GitHub Action CI tests all pass for your pull request * Be ready to adapt your changes after a code review ### Contributing Documentation @@ -46,11 +45,11 @@ There are a few things to consider for contributing code: 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) using [markdown syntax](https://help.github.com/articles/basic-writing-and-formatting-syntax/) - * the documentation published on [GitHub Pages](http://jmcgeheeiv.github.io/pyfakefs/), + * the [README](https://github.com/pytest-dev/pyfakefs/blob/main/README.md) using [markdown syntax](https://help.github.com/articles/basic-writing-and-formatting-syntax/) + * the documentation published on [GitHub Pages](http://pytest-dev.github.io/pyfakefs/), located in the `docs` directory (call `make html` from that directory). For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/). - * [this file](https://github.com/jmcgeheeiv/pyfakefs/blob/master/CONTRIBUTING.md) + * [this file](https://github.com/pytest-dev/pyfakefs/blob/main/CONTRIBUTING.md) if you want to enhance the contributing guide itself Thanks for taking the time to contribute to pyfakefs! |