Skip to content

Latest commit

 

History

History
181 lines (127 loc) · 9.44 KB

CONTRIBUTING.md

File metadata and controls

181 lines (127 loc) · 9.44 KB
Raw

Contributing to Metatype

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

I Have a Question

If you want to ask a question, we assume that you have read the available documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions depending on what seems relevant.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also make sure to search the internet (including Stack Overflow) to see if users outside the GitHub community have discussed the issue.
  • Collect information about the bug:
  • Stack trace
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
  • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
  • Possibly your input and the output
  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be reported according to the Security Policy.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Metatype, including completely new features and minor improvements to existing functionality. Following these guidelines will help us and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • Explain why this enhancement would be useful to most Metatype users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

Metatype is using a mono-repository approach. This means that all code is centralized and requires many different tools to work with. The following sections will guide you through the setup process.

Dependencies

Ghjk is used for managing development environments. You can install it using the following instructions.

# install ghjk
GHJK_VERSION="v0.2.1"
GHJK_INSTALL_HOOK_SHELLS=bash # add more shells if needed
curl -fsSL https://raw.githubusercontent.com/metatypedev/ghjk/$GHJK_VERSION/install.sh | sh
bash # re-open your shells to have the hooks register

# this will activate the environment after installing
# the required programs first
ghjk sync

# install system libraries
ghjk x install-sys | bash 

# enable pre-commit hook
pre-commit install

Running The Project

ghjk sync dev
# prepare python virtual environment
ghjk x install-py
source .venv/bin/activate # depends on your shell

Environments And Tests

ghjk x dev-compose all # or only the envs required (e.g. base prisma s3)
ghjk x build-tgraph # build typegraph
ghjk x test-e2e # all tests
ghjk x test-e2e tests/runtimes/prisma/full_prisma_mapping_test.ts # isolated test
ghjk x # more test tasks are availaible
ghjk x dev-compose # shutdown all envs

There are many more developer scripts in the dev folder, however most of them should only be needed for advanced tasks.

Commit Messages

Pre-commit hooks enforce some basic checks, namely that all commit messages follow the conventional commit format. This is a simple set of rules that makes review easier and help us to generate a changelog.

Faster compilation

We recommend using sccache giving a roughly 2x speedup in compilation time once warm.

Faster linking

mold is enabled by default for Linux targets whithin the ghjk environments. For macOS, there's a new parallel linker available for faster linking. You can use it through aliases or configure them in your ~/.cargo/config.toml file.

[target.aarch64-apple-darwin]
rustflags = [
    "-C", "link-arg=-fuse-ld=/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ld",
    "-C", "link-arg=-ld_new" # makes sure the new parallel linker is used
]

# ghjk aliases `ld` to `mold` by default so the following
# is not necessary
# [target.x86_64-unknown-linux-gnu]
# rustflags = [
#     "-C", "link-arg=-fuse-ld=/path/to/mold"
# ]

Local typegraph with Nodejs

Currently, the src/typegraph/node/ project is generated dynamically using the build-tgraph-ts-node ghjk task. Depending on your package manager, the protocol used may differ.

# uses the `file:..` protocol
npm install path/to/typegraph/sdk/node/

# uses the `link:..` protocol (equivalent to `file:..` but for directories only)
pnpm install path/to/typegraph/sdk/node/