Skip to content

Commit 2072ef2

Browse files
authored
Clarify maintenance status on README (#416)
* Clarify maintenance status on README * update review policy * add a note about error tests
1 parent ff558ee commit 2072ef2

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,29 @@ reasons:
9494

9595
## Contributing
9696

97-
Contributions are highly encouraged!
97+
Contributions are highly encouraged! However, the bandwidth we have to
98+
maintain this crate is fairly limited.
99+
100+
Pull requests that add support for or fix a bug in a feature in the
101+
SQL standard, or a feature in a popular RDBMS, like Microsoft SQL
102+
Server or PostgreSQL, will likely be accepted after a brief
103+
review.
104+
105+
The current maintainers do not plan for any substantial changes to
106+
this crate's API at this time. And thus, PRs proposing major refactors
107+
are not likely to be accepted.
108+
109+
Please be aware that, while we hope to review PRs in a reasonably
110+
timely fashion, it may take a while. In order to speed the process,
111+
please make sure the PR passes all CI checks, and includes tests
112+
demonstrating your code works as intended (and to avoid
113+
regressions). Remember to also test error paths.
114+
115+
PRs without tests will not be reviewed or merged. Since the CI
116+
ensures that `cargo test`, `cargo fmt`, and `cargo clippy`, pass you
117+
will likely want to run all three commands locally before submitting
118+
your PR.
98119

99-
Pull requests that add support for or fix a bug in a feature in the SQL
100-
standard, or a feature in a popular RDBMS, like Microsoft SQL Server or
101-
PostgreSQL, will almost certainly be accepted after a brief review. For
102-
particularly large or invasive changes, consider opening an issue first,
103-
especially if you are a first time contributor, so that you can coordinate with
104-
the maintainers. CI will ensure that your code passes `cargo test`,
105-
`cargo fmt`, and `cargo clippy`, so you will likely want to run all three
106-
commands locally before submitting your PR.
107120

108121
If you are unable to submit a patch, feel free to file an issue instead. Please
109122
try to include:
@@ -114,12 +127,11 @@ try to include:
114127
* links to documentation for the feature for a few of the most popular
115128
databases that support it.
116129

117-
Please be aware that, while we strive to address bugs and review PRs quickly, we
118-
make no such guarantees for feature requests. If you need support for a feature,
119-
you will likely need to implement it yourself. Our goal as maintainers is to
120-
facilitate the integration of various features from various contributors, but
121-
not to provide the implementations ourselves, as we simply don't have the
122-
resources.
130+
If you need support for a feature, you will likely need to implement
131+
it yourself. Our goal as maintainers is to facilitate the integration
132+
of various features from various contributors, but not to provide the
133+
implementations ourselves, as we simply don't have the resources.
134+
123135

124136
[tdop-tutorial]: https://eli.thegreenplace.net/2010/01/02/top-down-operator-precedence-parsing
125137
[`cargo fmt`]: https://github.com/rust-lang/rustfmt#on-the-stable-toolchain

0 commit comments

Comments
 (0)