This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-horaedb.git
The following commit(s) were added to refs/heads/main by this push:
new 70e9f0ea docs: update CONTRIBUTING.md (#1382)
70e9f0ea is described below
commit 70e9f0ea215956be4c85e237cb5396e147f843e4
Author: Suyan <[email protected]>
AuthorDate: Wed Dec 20 23:01:32 2023 +0800
docs: update CONTRIBUTING.md (#1382)
---
CONTRIBUTING.md | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5fc17d43..cac57f59 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,19 +3,16 @@
Thank you for thinking of contributing! We very much welcome contributions
from the community.
To make the process easier and more valuable for everyone involved we have a
few rules and guidelines to follow.
-Anyone with a GitHub account is free to file issues on the project.
-However, if you want to contribute documentation or code then you will need to
sign [CeresDB's Individual Contributor License Agreement
(CLA)](https://cla-assistant.io/CeresDB/ceresdb).
-
## Submitting Issues and Feature Requests
-Before you file an [issue](https://github.com/CeresDB/horaedb/issues/new),
please search existing issues in case the same or similar issues have already
been filed.
+Before you file an
[issue](https://github.com/apache/incubator-horaedb/issues/new), please search
existing issues in case the same or similar issues have already been filed.
If you find an existing open ticket covering your issue then please avoid
adding "đź‘Ť" or "me too" comments; GitHub notifications can cause a lot of noise
for the project maintainers who triage the back-log.
However, if you have a new piece of information for an existing ticket, and
you think it may help the investigation or resolution, then please do add it as
a comment!
You can signal to the team that you're experiencing an existing issue with one
of GitHub's emoji reactions (these are a good way to add "weight" to an issue
from a prioritisation perspective).
### Submitting an Issue
-The [New Issue](https://github.com/CeresDB/horaedb/issues/new) page has
templates for both bug reports and feature requests.
+The [New Issue](https://github.com/apache/incubator-horaedb/issues/new) page
has templates for both bug reports and feature requests.
Please fill one of them out!
The issue templates provide details on what information we will find useful to
help us fix an issue.
In short though, the more information you can provide us about your
environment and what behaviour you're seeing, the easier we can fix the issue.
@@ -27,21 +24,21 @@ For features, we don't plan to support we will close the
feature request ticket
## Contributing Changes
-HoraeDB is written mostly in idiomatic Rust—please see the [Style
Guide](https://ceresdb.github.io/docs/dev/style_guide.html) for more details.
+HoraeDB is written mostly in idiomatic Rust—please see the [Style
Guide](https://horaedb.apache.org/docs/dev/style_guide.html) for more details.
All code must adhere to the `rustfmt` format, and pass all of the `clippy`
checks we run in CI (there are more details further down this README).
### Making a PR
To open a PR you will need to have a GitHub account.
Fork the `horaedb` repo and work on a branch on your fork.
-When you have completed your changes, or you want some incremental feedback
make a Pull Request to HoraeDB
[here](https://github.com/CeresDB/horaedb/compare).
+When you have completed your changes, or you want some incremental feedback
make a Pull Request to HoraeDB
[here](https://github.com/apache/incubator-horaedb/compare).
If you want to discuss some work in progress then please prefix `[WIP]` to the
PR title.
For PRs that you consider ready for review, verify the following locally
before you submit it:
-* you have a coherent set of logical commits, with messages conforming to the
[Conventional
Commits](https://ceresdb.github.io/docs/dev/conventional_commit.html)
specification;
+* you have a coherent set of logical commits, with messages conforming to the
[Conventional
Commits](https://horaedb.apache.org/docs/dev/conventional_commit.html)
specification;
* all the tests and/or benchmarks pass, including documentation tests;
* the code is correctly formatted and all `clippy` checks pass; and
* you haven't left any "code cruft" (commented out code blocks etc).
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
