diff options
| -rw-r--r-- | .github/CONTRIBUTING.md | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9e27df94b..5b3e7fa2a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,10 +1,12 @@ -# Contributing to ZFS on Linux -<p align="center"><img src="http://zfsonlinux.org/images/zfs-linux.png"/></p> +# Contributing to OpenZFS +<p align="center"> + <img alt="OpenZFS Logo" + src="https://openzfs.github.io/openzfs-docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png"/> +</p> *First of all, thank you for taking the time to contribute!* -By using the following guidelines, you can help us make ZFS on Linux even -better. +By using the following guidelines, you can help us make OpenZFS even better. ## Table Of Contents [What should I know before I get @@ -69,12 +71,12 @@ list](https://openzfs.github.io/openzfs-docs/Project%20and%20Community/Mailing%2 or IRC if you aren't certain that you are experiencing a bug. If you run into an issue, please search our [issue -tracker](https://github.com/zfsonlinux/zfs/issues) *first* to ensure the +tracker](https://github.com/openzfs/zfs/issues) *first* to ensure the issue hasn't been reported before. Open a new issue only if you haven't found anything similar to your issue. You can open a new issue and search existing issues using the public [issue -tracker](https://github.com/zfsonlinux/zfs/issues). +tracker](https://github.com/openzfs/zfs/issues). #### When opening a new issue, please include the following information at the top of the issue: * What distribution (with version) you are using. @@ -106,13 +108,13 @@ information like: * Stack traces which may be logged to `dmesg`. ### Suggesting Enhancements -ZFS on Linux is a widely deployed production filesystem which is under -active development. The team's primary focus is on fixing known issues, -improving performance, and adding compelling new features. +OpenZFS is a widely deployed production filesystem which is under active +development. The team's primary focus is on fixing known issues, improving +performance, and adding compelling new features. You can view the list of proposed features by filtering the issue tracker by the ["Type: Feature" -label](https://github.com/zfsonlinux/zfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22). +label](https://github.com/openzfs/zfs/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%22). If you have an idea for a feature first check this list. If your idea already appears then add a +1 to the top most comment, this helps us gauge interest in that feature. @@ -137,7 +139,7 @@ logically independent patches which build on each other. This makes large changes easier to review and approve which speeds up the merging process. * Try to keep pull requests simple. Simple code with comments is much easier to review and approve. -* All proposed changes must be approved by a ZFS on Linux organization member. +* All proposed changes must be approved by an OpenZFS organization member. * If you have an idea you'd like to discuss or which requires additional testing, consider opening it as a draft pull request. Once everything is in good shape and the details have been worked out you can remove its draft status. Any required reviews can then be finalized and the pull request merged. @@ -146,7 +148,7 @@ Any required reviews can then be finalized and the pull request merged. * Every pull request will by tested by the buildbot on multiple platforms by running the [zfs-tests.sh and zloop.sh]( https://openzfs.github.io/openzfs-docs/Developer%20Resources/Building%20ZFS.html#running-zloop-sh-and-zfs-tests-sh) test suites. * To verify your changes conform to the [style guidelines]( -https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md#style-guides +https://github.com/openzfs/zfs/blob/master/.github/CONTRIBUTING.md#style-guides ), please run `make checkstyle` and resolve any warnings. * Static code analysis of each pull request is performed by the buildbot; run `make lint` to check your changes. * Test cases should be provided when appropriate. @@ -156,7 +158,7 @@ This includes making sure new features have adequate code coverage. Buildbot](http://build.zfsonlinux.org/) builders before being accepted. If you are experiencing intermittent TEST builder failures, you may be experiencing a [test suite -issue](https://github.com/zfsonlinux/zfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Test+Suite%22). +issue](https://github.com/openzfs/zfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Test+Suite%22). There are also various [buildbot options](https://openzfs.github.io/openzfs-docs/Developer%20Resources/Buildbot%20Options.html) to control how changes are tested. @@ -168,7 +170,7 @@ range of realistic workloads, configurations and architectures we're better able quickly identify and resolve potential issues. Users can also run the [ZFS Test -Suite](https://github.com/zfsonlinux/zfs/tree/master/tests) on their systems +Suite](https://github.com/openzfs/zfs/tree/master/tests) on their systems to verify ZFS is behaving as intended. ## Style Guides |