You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
3
+
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.
4
4
5
-
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.
5
+
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.
6
6
7
-
We also have:
8
-
9
-
- A community [Discord server](https://hash.ai/discord) where you can ask questions about contributing, and obtain helpful advice
10
-
- A developer website at [hash.dev](https://hash.dev/), containing developer tutorials, guides and other resources
11
-
- A design website at [hash.design](https://hash.design/) containing our Storybook, brand and style guildelines
7
+
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
12
8
13
9
## About this repo
14
10
@@ -20,20 +16,20 @@ To ascertain the license and contributing policy for a given project, check out
20
16
21
17
These apply across all projects:
22
18
23
-
- 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.
19
+
- 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).
24
20
- 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.
25
21
- Always include a link to the issue or discussion proposing the change.
26
22
- Write tests to accompany your PR, or ask for help/guidance if this is a blocker.
27
23
- Make sure that your PR doesn’t break existing tests.
28
24
- The repository follows a set of linting rules. Many of them can be applied automatically by running `yarn install` and `yarn fix`.
29
-
- 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))
25
+
- 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))
30
26
- Once you have receive a pull request review, please bear the following in mind:
31
27
- 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.
32
28
- 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.
33
29
34
30
## How can I find interesting PRs to work on?
35
31
36
-
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!
32
+
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!
37
33
38
34
## Why might contributions be rejected?
39
35
@@ -42,11 +38,11 @@ There are a number of reasons why otherwise sound contributions might not find t
42
38
-**PRs that introduce new functionality without proper tests will not be accepted.** You should write meaningful tests for your code.
43
39
-**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.
44
40
-**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.
45
-
-**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).
41
+
-**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).
46
42
-**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.
47
43
-**PRs that introduce architectural changes to the project** (without prior discussion and agreement) will be rejected.
48
44
-**PRs that don’t match the syntax, style and formatting of the project will be rejected.** See: _maintainability_.
49
45
50
46
## Can I work for HASH full-time?
51
47
52
-
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.
48
+
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.
Copy file name to clipboardexpand all lines: apps/sim-engine/CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
_Thank you for your interest in contributing to the HASH Engine (aka. hEngine)_
6
6
7
7
We've provided the following guidelines to help you with contributions, in addition to the ones described below, we've
8
-
also established a set of [community guidelines](https://hash.ai/legal/community) to enable as many people as possible
8
+
also established a set of [community guidelines](https://hash.ai/legal/trust-safety/community?utm_medium=organic&utm_source=github_readme_labs-repo_sim-engine-contributing-guide) to enable as many people as possible
9
9
to contribute to and benefit from HASH. Please follow these when interacting with this repo.
10
10
11
11
## Table Of Contents
@@ -32,7 +32,7 @@ to contribute to and benefit from HASH. Please follow these when interacting wit
32
32
33
33
## I have a question, where do I go?
34
34
35
-
If you have a question, you can ask it on our [community forum](https://hash.community/) or join our public [Discord server](https://hash.ai/discord) (requires a HASH account). Please don't use GitHub issues for general help or discussions. You can also get in touch with us directly via any of the methods outlined on [our site](https://hash.ai/contact).
35
+
If you have an issue, you can [open an issue](https://github.com/hashintel/labs/issues) in our [`labs` repository](https://github.com/hashintel/labs). If you have a general question, you can also [create a discussion](https://github.com/hashintel/labs/discussions) in the same repository, although we monitor these less frequently. Finally, you can also get in touch with us directly via any of the methods outlined on [our site](https://hash.ai/contact?utm_medium=organic&utm_source=github_readme_labs-repo_sim-engine-contributing-guide).
36
36
37
37
## Getting started, what do I need to know?
38
38
@@ -76,7 +76,7 @@ So you've found a bug, next up is collecting useful information to give us to in
76
76
77
77
### Suggesting Enhancements
78
78
79
-
If you have ideas of how to improve the hEngine, feel free to submit them on the [Product Feedback section of our community forum](https://community.hash.ai/c/product-feedback/2). If you want a more informal discussion around your ideas feel free to start a conversation on the Discord!
79
+
If you have ideas of how to improve the hEngine, feel free to submit them as GitHub issues on this repository.
80
80
81
81
<!--
82
82
The following sections are comments until the wishlist section of the new website is live
@@ -153,4 +153,4 @@ cargo clippy
153
153
154
154
### Hiring
155
155
156
-
**We're growing the team behind HASH.** If you like what we've built, have contributed to the repo, or are otherwise interested in a full-time role, check out our [open opportunities](https://hash.ai/careers).
156
+
**We're growing the team behind HASH.** If you like what we've built, have contributed to the repo, or are otherwise interested in a full-time role, check out our [open opportunities](https://hash.ai/careers?utm_medium=organic&utm_source=github_readme_labs-repo_sim-engine-contributing-guide).
<ahref="https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine"><imgsrc="https://img.shields.io/discord/840573247803097118"alt="Join HASH on Discord" /></a>
7
6
<ahref="https://github.com/hashintel/labs#"><imgsrc="https://img.shields.io/github/stars/hashintel/labs?label=Star%20on%20GitHub&style=social"alt="Star on GitHub"></a>
8
7
</div>
9
8
@@ -44,18 +43,14 @@ Our ultimate intention is to migrate both hCore and hCloud to use the engine und
44
43
45
44
## Issue Tracking
46
45
47
-
We use [GitHub Issues](https://github.com/hashintel/labs/issues) to help prioritize and track bugs and feature requests. Please use the [HASH Engine Issue form](https://github.com/hashintel/labs/issues/new?assignees=&labels=A-engine%2CC-bug&template=bug-report-hash-engine.yml) to help us deal with your report most effectively. If you're unsure about something or need help, you can also ask questions and get support on our public [Discord server](https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine).
46
+
We use [GitHub Issues](https://github.com/hashintel/labs/issues) to help prioritize and track bugs and feature requests. Please use the [HASH Engine Issue form](https://github.com/hashintel/labs/issues/new?assignees=&labels=A-engine%2CC-bug&template=bug-report-hash-engine.yml) to help us deal with your report most effectively.
48
47
49
48
## Additional Documentation
50
49
51
50
Our [user guide for simulation](https://hash.ai/docs/simulation?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine) contains a beginner's introduction as well as in-depth tutorials for **hCore** today.
52
51
53
52
The [HASH glossary](https://hash.ai/glossary?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine) contains helpful explainers around key modeling, simulation and AI-related terms and concepts.
54
53
55
-
## Questions & Support
56
-
57
-
We're building a community of people who care about enabling better decision-making through modeling and simulation. Our [support forum](https://hash.community/?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine) and [HASH community Discord server](https://hash.ai/discord?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine) (requires login) are both great places to meet other modelers and get help.
58
-
59
54
## The State of Development
60
55
61
56
As outlined above, this project is the next-generation of our simulation engine, and differs from the one currently powering [hCore](https://hash.ai/platform/core?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine) and [hCloud](https://hash.ai/platform/cloud?utm_medium=organic&utm_source=github_readme_labs-repo_apps-sim-engine). It's published here as a pre-release technology preview, and as such the feature-set and codebase should be considered unstable until it's released. That means that there are a number of features you may use on the HASH platform that at present may not be supported by this project, notably:
0 commit comments