This is an automated email from the ASF dual-hosted git repository. jiacai2050 pushed a commit to branch feat-mail in repository https://gitbox.apache.org/repos/asf/horaedb-docs.git
commit 49d8c8e3abd36e1f1dd0909c470635e37b2c7e07 Author: jiacai2050 <[email protected]> AuthorDate: Mon Oct 28 15:40:17 2024 +0800 feat: how to subscribe mail lists --- content/en/community/_index.md | 30 +++++++++ content/en/docs/contribution-guidelines.md | 104 ----------------------------- hugo.toml | 17 +++-- 3 files changed, 41 insertions(+), 110 deletions(-) diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 3950ee6..78aed0b 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -1,6 +1,36 @@ --- title: "Community" +params: + contributingUrl: https://github.com/apache/horaedb/blob/main/CONTRIBUTING.md menu: main: weight: 40 --- + +{{% blocks/section color="white" %}} +# How to Subscribe Mail List + +Mailing lists are a form of communication used by the Apache community. Generally speaking, many things in the Apache community are hosted by mailing lists, For example: project q&A, technical discussion, transaction decision, release vote, etc，By subscribing, you can get the first update of the HoraeDB community and keep up with the community. The following list is the main list we are using: + +- [email protected], Community activity information +- [email protected], Code repo update information + +For subscribing to the [email protected] mailing list, the steps are as follows： + +- Send an email without any content or subject: [email protected] +- Wait until you receive an email with the subject line confirm subscribe to [email protected] (if you have not received it for a long time, please confirm whether the email is blocked by your email, if you have not been blocked and will receive a reply for a long time, return to step 1) +- Reply directly to the email without changing the subject line or adding the email content. +- Wait until you receive an email with the subject line WELCOME to [email protected] . +- If you receive an email from dev, you have successfully subscribed to the email. To initiate a discussion, you can send an email directly to [email protected], which will be sent to everyone who subscribed to the mailing list. + +## Unsubscribe from the mail list + +The steps for unsubscribing to a mailing list are similar to those for subscribing to a mailing list:： + +- Send an email without any content or subject to: [email protected] +- Wait until you receive an email with the subject line confirm unsubscribe from [email protected] +- Reply directly to the email without changing the subject line or adding the email content +- Wait until you receive an email with the subject line GOODBYE from [email protected] +- Unsubscribe success + +{{% /blocks/section %}} diff --git a/content/en/docs/contribution-guidelines.md b/content/en/docs/contribution-guidelines.md deleted file mode 100644 index 36aafbf..0000000 --- a/content/en/docs/contribution-guidelines.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "Contribution Guidelines" -weight: 30 ---- - -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. - -## Submitting Issues and Feature Requests - -Before you file an [issue](https://github.com/apache/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/apache/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. -If you can push a PR with test cases that trigger a defect or bug, even better! - -As well as bug reports we also welcome feature requests (there is a dedicated issue template for these). -Typically, the maintainers will periodically review community feature requests and make decisions about if we want to add them. -For features, we don't plan to support we will close the feature request ticket (so, again, please check closed tickets for feature requests before submitting them). - -## Contributing Changes - -HoraeDB is written mostly in idiomatic Rust—please see the [Style Guide]({{< ref "style_guide.md" >}}) 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/apache/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]({{< ref "conventional_commit.md" >}}) 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). - -There are some tips on verifying the above in the [next section](#running-tests). - -**After** submitting a PR, you should: - -- verify that all CI status checks pass and the PR is 💚; -- ask for help on the PR if any of the status checks are 🔴, and you don't know why; -- wait patiently for one of the team to review your PR, which could take a few days. - -## Running Tests - -The `cargo` build tool runs tests as well. Run: - -```shell -cargo test --workspace -``` - -### Enabling logging in tests - -To enable logging to stderr during a run of `cargo test` set the Rust -`RUST_LOG` environment variable. For example, to see all INFO messages: - -```shell -RUST_LOG=info cargo test --workspace -``` - -### Integration tests - -We have integration test suits in the SQL level so any change that may have influence on the user-facing query execution should be covered by the integration test. Refer to [this document](./integration_tests/README.md) for more information. - -## Running `rustfmt` and `clippy` - -CI will check the code formatting with [`rustfmt`](https://github.com/rust-lang/rustfmt) and Rust best practices with [`clippy`](https://github.com/rust-lang/rust-clippy). - -To automatically format your code according to `rustfmt` style, first make sure `rustfmt` is installed using `rustup`: - -```shell -rustup component add rustfmt -``` - -Then, whenever you make a change and want to reformat, run: - -```shell -cargo fmt --all -``` - -Similarly, with `clippy`, install with: - -```shell -rustup component add clippy -``` - -And run with: - -```shell -cargo clippy --all-targets --workspace -- -D warnings -``` diff --git a/hugo.toml b/hugo.toml index 79870cf..12b3da3 100644 --- a/hugo.toml +++ b/hugo.toml @@ -52,6 +52,16 @@ offlineSearch = true url = "https://github.com/apache/horaedb/discussions"; icon = "fab fa-github" desc = "Discussion and help from your fellow users" +[[params.links.user]] + name = "Discord" + url = "https://discord.gg/h5r4kVMRYN"; + icon = "fab fa-discord" + desc = "Chat with other project developers/users from all over the world" +[[params.links.user]] + name = "DingTalk" + url = "/images/dingtalk.jpg" + icon = "fa-regular fa-comments" + desc = "Chat with other project developers/users from China" [[params.links.user]] name = "Weixin Official Accounts" url = "/images/weixin-mp.jpg" @@ -63,14 +73,9 @@ offlineSearch = true url = "https://github.com/apache/horaedb"; icon = "fab fa-github" desc = "Development takes place here!" -[[params.links.developer]] - name = "DingTalk" - url = "/images/dingtalk.jpg" - icon = "fa-regular fa-comments" - desc = "Chat with other project developers on DingTalk" [[params.links.developer]] name = "Developer mailing list" - url = "mailto:[email protected]"; + url = "https://lists.apache.org/[email protected]"; icon = "fa fa-envelope" desc = "Discuss development issues around the project" --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
