Bỏ qua

Help DATAMIMIC - Get Help

Warning

The current page still doesn't have a translation for this language.

But you can help translating it: Contributing.

🚀 Use DATAMIMIC? Want to help the project, support other users, or get help yourself? Below are the main ways to do each — most take only one or two clicks.

Subscribe to the newsletter

Subscribe to the (infrequent) DATAMIMIC data masters newsletter for:

  • News about DATAMIMIC
  • Guides
  • Features
  • Breaking changes
  • Tips and tricks

Star DATAMIMIC in GitHub

"Star" DATAMIMIC in GitHub (star button, top right): https://github.com/rapiddweller/datamimic.

Stars help other users find the project and signal that it has been useful.

Follow DATAMIMIC on X

Follow @DATAMIMIC on X for the latest news.

Connect with the authors from rapiddweller

You can connect with us (rapiddweller), the authors.

You can:

Help others with questions in GitHub

You can try and help others with their questions in:

In many cases you will already know the answer.

If you consistently help others, you will be recognised as a DATAMIMIC Expert{.internal-link target=_blank}.

Be kind. People often arrive with their own constraints, and the way they ask may not always be ideal — assume good faith.

The DATAMIMIC community aims to be welcoming. Bullying or disrespect toward others is not tolerated.

Here's how to help others with questions (in discussions or issues):

Understand the question

  • Check that you understand the goal and the specific scenario behind the question.
  • Check that the question itself is clearly stated.
  • Often the question proposes a solution the user already has in mind — understanding the underlying problem may reveal a better alternative.
  • If the question is unclear, ask for more information.

Reproduce the problem

For most of the cases and most of the questions there's something related to the person's original DATAMIMIC model.

In many cases they will only copy a small snippet of the code, but that's not enough to reproduce the problem.

  • Ask for a minimal, reproducible example you can copy-paste and run locally to see the same error or behaviour.

  • You can also try to build a sample yourself from the problem description, but this is often time-consuming — usually it's faster to ask for a clearer explanation first.

Suggest solutions

  • After being able to understand the issue or question, you can give them a possible answer.

  • Often it's better to understand their underlying problem or use case, because there might be a better way to solve it than what they are trying to do.

Ask to close

If their reply indicates the problem is solved, you can ask them to:

* In GitHub Discussions: mark the comment as the **answer**.
* In GitHub Issues: **close** the issue.

Watch the GitHub repository

"Watch" DATAMIMIC on GitHub (watch button, top right): https://github.com/rapiddweller/datamimic.

Select "Watching" instead of "Releases only" to get notifications when someone creates a new issue or question. You can also narrow notifications to issues, discussions, or PRs.

Ask Questions

Create a new question in the GitHub repository to:

  • Ask a question or report an issue.
  • Suggest a new feature.

Review Pull Requests

Help review pull requests from community contributions. Be kind in your feedback.

Here's what to have in mind and how to review a pull request:

Understand the problem

  • First, make sure you understand the issue that the pull request is trying to solve. It might have a longer thread in a GitHub Discussion or issue with additional context.

  • There's also a good chance that the pull request is not actually needed because the problem can be solved in a different way. Then you can suggest or ask about that.

Check the code

  • Check and read the code, see if it makes sense, run it locally and see if it actually solves the problem.

  • Subsequently, please leave a comment indicating that you have really executed the code; this will inform us that you have indeed reviewed it.

Tests

  • Check that the PR has tests.
  • Check that the tests fail before the PR.
  • Check that the tests pass after the PR.
  • If a PR has no tests, remind the author to add them, or suggest tests yourself.
  • Comment on what you tried so the maintainers know it was checked.

Create a Pull Request

You can contribute to the source code with Pull Requests, for example:

  • To fix an existing issue/bug.
    • Make sure to add tests.
  • To add a new feature.
    • Make sure to add tests.
    • Make sure to add documentation if it's relevant.

Help Maintain DATAMIMIC

The two highest-leverage tasks anyone can help with:

These are the most time-consuming parts of maintaining the DATAMIMIC community edition. Any help here directly supports the project.

Thanks from the rapiddweller team and the DATAMIMIC community.