Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.92 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.92 KB
Raw

Dwarves Memo

✍ https://memo.d.foundation ✍
The vault of knowledge where we keep our internal notes from everything related to our engineering practices, new tech we are learning, and as well as business and hiring notices

About this project

This is the repository where we keep our internal notes. We use this repo to share our knowledge, insights, and experiences with each other before we make it generally available to our community.

Getting Started

We welcome contributions from anyone who is interested in our topics. You can contribute by creating a new note, editing an existing note, or commenting on a note. To do so, you need to follow these steps:

  1. Fork this repo and clone it to your local machine.
  2. Install Devbox, a command-line tool that lets you easily create isolated shells and containers for development. Devbox will help you set up a consistent and reproducible environment for this repo, with all the necessary tools and dependencies installed.
  3. Run devbox shell in the root directory of the repo to enter an isolated shell. Alternatively, you can use VSCode with the Remote - Containers extension to open the repo as a devcontainer.

To run the server, you can run our Makefile command:

make watch-run

or through devbox:

devbox run watch-run

Code of conduct

We expect all contributors to adhere to our code of conduct, which is based on the Contributor Covenant. By participating in this project, you agree to abide by its terms. Please report any unacceptable behavior to [email protected].

Credits

A big thank to all who contributed to this project!

If you'd like to contribute, please check out the the above Code of conduct guide.