... | ... | @@ -48,34 +48,10 @@ The enforcement policies listed above apply to all official Memri venues, includ |
|
|
Adapted from the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](https://www.contributor-covenant.org/version/1/3/0/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Outdated:
|
|
|
|
|
|
We are excited that you are looking to contribute to memri! This document helps you to become a great member of our community.
|
|
|
|
|
|
## Getting an overview
|
|
|
Memri has a lot of moving parts, [to explain what they are we wrote an article about it.](https://memri.io/overview.html)
|
|
|
|
|
|
## Installation
|
|
|
To install memri, have a look at our [getting started blogpost](https://blog.memri.io/tutorial-setting-up-memri/)
|
|
|
|
|
|
## How to help
|
|
|
|
|
|
### Understand and improve what we have
|
|
|
Good ways to learn our codebase and help the community at the same time are:
|
|
|
- Writing usage examples
|
|
|
- Writing tests
|
|
|
- Writing documentation
|
|
|
|
|
|
### Extend what we have
|
|
|
Other, maybe more interesting ways to help is extending the functionalities in our ecosystem.
|
|
|
- [Writing the interface for your data](https://blog.memri.io/cvu-language-part-1/)
|
|
|
- [Writing downloaders](https://blog.memri.io/tutorial-creating-a-downloader/) that download your data from external datasources to your pod
|
|
|
- [Writing indexers](https://blog.memri.io/tutorial-creating-an-indexer/) that enrich your data by applying models to it
|
|
|
|
|
|
# Merge request guidelines
|
|
|
|
|
|
- Aim to have one MR per problem, and use branches enable that. If you are solving a new problem before the current MR is closed, create a new MR which does not include the changes it the first MR. If you get a request for changes for a MR, don’t submit a new MR but proceed within the existing MR
|
|
|
|
|
|
- Only create MR’s that change functionality. Don’t combine them with style changes, like whitespaces, symbol naming, etc.
|
|
|
|
|
|
## Codestyle
|
... | ... | |