Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

OpenZFSify CONTRIBUTING.md 

Update stale references to "ZFS on Linux" to "OpenZFS" in
CONTRIBUTING.md.

Reviewed-by: George Melikov <mail@gmelikov.ru>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ryan Moeller <ryan@iXsystems.com>
Closes #10602
This commit is contained in:
Ryan Moeller 2020-07-22 14:09:04 -04:00 committed by GitHub
parent 0c79b070a7
commit db5b3926e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
.github/CONTRIBUTING.md vendored
View File

@ -1,10 +1,12 @@
# Contributing to ZFS on Linux # Contributing to OpenZFS
<p align="center"><img src="http://zfsonlinux.org/images/zfs-linux.png"/></p> <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!* *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 By using the following guidelines, you can help us make OpenZFS even better.
better.
## Table Of Contents ## Table Of Contents
[What should I know before I get [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. or IRC if you aren't certain that you are experiencing a bug.
If you run into an issue, please search our [issue 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 issue hasn't been reported before. Open a new issue only if you haven't
found anything similar to your issue. found anything similar to your issue.
You can open a new issue and search existing issues using the public [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: #### When opening a new issue, please include the following information at the top of the issue:
* What distribution (with version) you are using. * What distribution (with version) you are using.
@ -106,13 +108,13 @@ information like:
* Stack traces which may be logged to `dmesg`. * Stack traces which may be logged to `dmesg`.
### Suggesting Enhancements ### Suggesting Enhancements
ZFS on Linux is a widely deployed production filesystem which is under OpenZFS is a widely deployed production filesystem which is under active
active development. The team's primary focus is on fixing known issues, development. The team's primary focus is on fixing known issues, improving
improving performance, and adding compelling new features. performance, and adding compelling new features.
You can view the list of proposed features You can view the list of proposed features
by filtering the issue tracker by the ["Type: Feature" 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 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 appears then add a +1 to the top most comment, this helps us gauge interest
in that feature. 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. 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 * Try to keep pull requests simple. Simple code with comments is much easier
to review and approve. 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. * 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. 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. 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]( * 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. 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]( * 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. ), 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. * 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. * 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 Buildbot](http://build.zfsonlinux.org/) builders before
being accepted. If you are experiencing intermittent TEST being accepted. If you are experiencing intermittent TEST
builder failures, you may be experiencing a [test suite 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) There are also various [buildbot options](https://openzfs.github.io/openzfs-docs/Developer%20Resources/Buildbot%20Options.html)
to control how changes are tested. 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. able quickly identify and resolve potential issues.
Users can also run the [ZFS Test 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. to verify ZFS is behaving as intended.
## Style Guides ## Style Guides