From 257ede2d6da69c675d3e6c34a46396e011531415 Mon Sep 17 00:00:00 2001 From: Dei Vilkinsons <6226576+vilkinsons@users.noreply.github.com> Date: Fri, 5 Jul 2024 09:23:40 +0200 Subject: [PATCH] H-3053: Update references to Discord (#57) * Update README.md * Update CONTRIBUTING.md * Update README.md * Update HashCoreHeaderMenuHelp.tsx * Update DiscordWidget.tsx * Update CONTRIBUTING.md * Update README.md * Update README.md * Update README.md * Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 20 ++++++++----------- README.md | 3 +-- .../process-modeler/README.md | 3 +-- apps/sim-core/README.md | 3 +-- .../DiscordWidget/DiscordWidget.tsx | 8 +++++++- .../Menu/Help/HashCoreHeaderMenuHelp.tsx | 12 +++++------ apps/sim-engine/CONTRIBUTING.md | 8 ++++---- apps/sim-engine/README.md | 7 +------ apps/sim-engine/stdlib/CONTRIBUTING.md | 20 +++++++++---------- apps/sim-engine/stdlib/README.md | 8 ++++---- 10 files changed, 42 insertions(+), 50 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f59ec6d..4be95b6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,14 +1,10 @@ # Contributing -Thanks for taking the time to contribute! 🎉 We've established a set of [community guidelines](https://hash.ai/legal/community) to enable as many people as possible to contribute to and benefit from HASH. Please follow these when interacting with this repo. +Thanks for taking the time to contribute! 🎉 We've established a set of [community guidelines](https://hash.ai/legal/trust-safety/community?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide) to enable as many people as possible to contribute to and benefit from HASH. Please follow these when interacting with this repo. -If you'd like to make a significant change or re-architecture to this repository or any project within, please first open a [discussion](https://github.com/hashintel/hash/discussions) or create an [issue](https://github.com/hashintel/hash/issues) to get feedback before spending too much time. +If you'd like to make a significant change or re-architecture to this repository or any project within, please first open a [discussion](https://github.com/hashintel/labs/discussions) or create an [issue](https://github.com/hashintel/labs/issues) to get feedback before spending too much time. -We also have: - -- A community [Discord server](https://hash.ai/discord) where you can ask questions about contributing, and obtain helpful advice -- A developer website at [hash.dev](https://hash.dev/), containing developer tutorials, guides and other resources -- A design website at [hash.design](https://hash.design/) containing our Storybook, brand and style guildelines +We also have a developer website at [hash.dev](https://hash.dev/?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide), containing developer tutorials, guides and other resources ## About this repo @@ -20,20 +16,20 @@ To ascertain the license and contributing policy for a given project, check out These apply across all projects: -- Before undertaking any significant work, please share your proposal with us: we don't want you to invest your time on changes we are already working on ourselves, or have different plans for. You can suggest changes as a [discussion](https://github.com/hashintel/hash/discussions) if it's a feature proposal, or an [issue](https://github.com/hashintel/hash/issues) if it's a bug you intend to fix. If you're unsure, you can always chat to us on [Discord](https://hash.ai/discord) first. If it's a typo or docs change, don't worry about this step. +- Before undertaking any significant work, please share your proposal with us: we don't want you to invest your time on changes we are already working on ourselves, or have different plans for. You can suggest changes as a [discussion](https://github.com/hashintel/labs/discussions) if it's a feature proposal, or an [issue](https://github.com/hashintel/labs/issues) if it's a bug you intend to fix. If it's a typo or minor docs change, you can always open a PR directly (don't worry about this step). - When submitting a pull request, please fill out any sections of the provided template you feel able to. If you are unsure or don't feel a section is relevant, please say so. - Always include a link to the issue or discussion proposing the change. - Write tests to accompany your PR, or ask for help/guidance if this is a blocker. - Make sure that your PR doesn’t break existing tests. - The repository follows a set of linting rules. Many of them can be applied automatically by running `yarn install` and `yarn fix`. - - Sign our _Contributor License Agreement_ at the CLA Assistant's prompting. (To learn more, read [why we have a CLA](https://hash.ai/legal/cla)) + - Sign our _Contributor License Agreement_ at the CLA Assistant's prompting. (To learn more, read [why we have a CLA](https://hash.ai/legal/developers/contributing?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide)) - Once you have receive a pull request review, please bear the following in mind: - reviewers may make suggestions for _optional_ changes which are not required to get your code merged. It should be obvious which suggestions are optional, and which are required changes. If it is not obvious, ask for clarification. - please do not resolve comment threads unless you opened them - leave it to the person who raised a comment to decide if any further discussion is required (GitHub will also automatically resolve any code suggestions you click 'commit' on). Comment threads may also be left open so that they can be linked to later. ## How can I find interesting PRs to work on? -Existing issues can provide a good source of inspiration for potential contributions. The issue tags `E-help-wanted` and `E-good-first-issue` flag some of the lower-hanging fruit that are available for people (including first-time contributors) to work on, without necessarily requiring prior discussion. You should also feel free to join our [HASH Discord](https://hash.ai/discord) and reach out directly to us for more inspiration. If you're willing to contribute, we'd love to have you! +Existing issues can provide a good source of inspiration for potential contributions. The issue tags `E-help-wanted` and `E-good-first-issue` flag some of the lower-hanging fruit that are available for people (including first-time contributors) to work on, without necessarily requiring prior discussion. You should also feel free to [reach out directly](https://hash.ai/contact?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide) to us for more inspiration. If you're willing to contribute, we'd love to have you! ## Why might contributions be rejected? @@ -42,11 +38,11 @@ There are a number of reasons why otherwise sound contributions might not find t - **PRs that introduce new functionality without proper tests will not be accepted.** You should write meaningful tests for your code. - **PRs that fail to pass tests will not be merged.** If your PR doesn’t pass our Continuous Integration tests, it won’t be merged. - **PRs that duplicate functionality which already exist in HASH, but outside of the project you're introducing them in.** For example, recreating functionality provided in one package directly within another. -- **PRs that duplicate workstreams already under development at HASH** may be rejected, or alternatively integrated into working branches other than those intended by the contributor. For more on these, see our [public roadmap](https://hash.ai/roadmap). +- **PRs that duplicate workstreams already under development at HASH** may be rejected, or alternatively integrated into working branches other than those intended by the contributor. For more on these, see our [public roadmap](https://hash.dev/roadmap?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide). - **PRs that add functionality that is only useful to a subset of users**, which may increase maintenance overheads on the product. We know it can be frustrating when these sorts of PRs are rejected, and it can sometimes seem arbitrary. We’ll do our best to communicate our rationale clearly in such instances and are happy to talk it out. It's impossible to forecast all of the possible use-cases of a product or feature, and we try to keep an open posture towards such contributions. - **PRs that introduce architectural changes to the project** (without prior discussion and agreement) will be rejected. - **PRs that don’t match the syntax, style and formatting of the project will be rejected.** See: _maintainability_. ## Can I work for HASH full-time? -We're recruiting for a number of full-time roles. If you've already contributed to this repo or our [primary `hash` monorepo](https://github.com/hashintel/hash), mention this in your application. View our open roles at [hash.ai/careers](https://hash.ai/careers) and drop your name in the pool even if you can't see a good fit right now. +We're recruiting for a number of full-time roles. If you've already contributed to this repo or our [primary `hash` monorepo](https://github.com/hashintel/hash), mention this in your application. View our open roles at [hash.ai/careers](https://hash.ai/careers?utm_medium=organic&utm_source=github_readme_labs-repo_dot-github-contributing-guide) and drop your name in the pool even if you can't see a good fit right now. diff --git a/README.md b/README.md index b94a0c0..9cb23b1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -[discord]: https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_root [github_star]: https://github.com/hashintel/labs# [hash]: https://hash.ai/platform/hash?utm_medium=organic&utm_source=github_readme_labs-repo_root [hash core]: https://hash.ai/platform/core?utm_medium=organic&utm_source=github_readme_labs-repo_root [hash engine]: https://hash.ai/platform/engine?utm_medium=organic&utm_source=github_readme_labs-repo_root [repository guidelines]: https://github.com/hashintel/labs/blob/main/.github/CONTRIBUTING.md -[![discord](https://img.shields.io/discord/840573247803097118)][discord] [![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] +[![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] # Labs diff --git a/apps/sim-core-plugins/process-modeler/README.md b/apps/sim-core-plugins/process-modeler/README.md index 64f4afd..7a89f60 100644 --- a/apps/sim-core-plugins/process-modeler/README.md +++ b/apps/sim-core-plugins/process-modeler/README.md @@ -1,10 +1,9 @@ -[discord]: https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core-plugin-pm [github_star]: https://github.com/hashintel/labs# [hash]: https://hash.ai/platform/hash?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core-plugin-pm [hash core]: https://hash.ai/platform/core?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core-plugin-pm [hash engine]: https://hash.ai/platform/engine?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core-plugin-pm -[![discord](https://img.shields.io/discord/840573247803097118)][discord] [![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] +[![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] # hCore Business Process Modeling Plugin diff --git a/apps/sim-core/README.md b/apps/sim-core/README.md index eb3394f..d6da839 100644 --- a/apps/sim-core/README.md +++ b/apps/sim-core/README.md @@ -1,10 +1,9 @@ -[discord]: https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core [github_star]: https://github.com/hashintel/labs# [hash]: https://hash.ai/platform/hash?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core [hash core]: https://hash.ai/platform/core?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core [hash engine]: https://hash.ai/platform/engine?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-core -[![discord](https://img.shields.io/discord/840573247803097118)][discord] [![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] +[![github_star](https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social)][github_star] # HASH Core diff --git a/apps/sim-core/packages/core/src/components/DiscordWidget/DiscordWidget.tsx b/apps/sim-core/packages/core/src/components/DiscordWidget/DiscordWidget.tsx index 643c77c..d33940e 100644 --- a/apps/sim-core/packages/core/src/components/DiscordWidget/DiscordWidget.tsx +++ b/apps/sim-core/packages/core/src/components/DiscordWidget/DiscordWidget.tsx @@ -12,7 +12,13 @@ import { selectActivityVisible } from "../../features/viewer/selectors"; import "./DiscordWidget.css"; -export const DISCORD_URL = "https://discord.gg/BPMrGAhjPh"; +export const DISCORD_URL = "https://github.com/hashintel/labs/discussions"; + +/** + * On 2024-07-02 our Discord was deprecated. As a temporary patch, we're simply + * changing the link here to point to the discussions page in our `labs` GitHub + * repository, to ensure there is some public space users can comment. + */ /** * @warning This component specifically does not rely on a Redux store being in diff --git a/apps/sim-core/packages/core/src/components/HashCore/Header/Menu/Help/HashCoreHeaderMenuHelp.tsx b/apps/sim-core/packages/core/src/components/HashCore/Header/Menu/Help/HashCoreHeaderMenuHelp.tsx index 2fa9afb..bc534ae 100644 --- a/apps/sim-core/packages/core/src/components/HashCore/Header/Menu/Help/HashCoreHeaderMenuHelp.tsx +++ b/apps/sim-core/packages/core/src/components/HashCore/Header/Menu/Help/HashCoreHeaderMenuHelp.tsx @@ -38,7 +38,7 @@ export const HashCoreHeaderMenuHelp: FC = memo(