Env Configuration + Readme Tweaks (#35)

.env.example

@@ -1,3 +1,6 @@
-DATABASE_URL=postgres://mina:whatever@localhost:5432/archive
+MINAMESH_ARCHIVE_DATABASE_URL=postgres://mina:whatever@localhost:5432/archive
+MINAMESH_GENESIS_BLOCK_IDENTIFIER_STATE_HASH=3NK4BpDSekaqsG6tx8Nse2zJchRft2JpnbvMiog55WCr5xJZaKeP
+MINAMESH_GENESIS_BLOCK_IDENTIFIER_HEIGHT=359605
+
 RUST_LOG=debug,error,mina_mesh=info
 RUST_ENV=production

.github/workflows/checks.yaml

@@ -56,6 +56,7 @@ jobs:
           key: ${{ runner.os }}-test-${{ hashFiles('**/Cargo.lock') }}
       - name: Setup
         run: |
+          cp .env.example .env
           just get-mainnet-archive-db
           just pg
           just wait-for-pg

CODE_OF_CONDUCT.md

@@ -0,0 +1,117 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or
+sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
+healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
+  experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their
+  explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
+and will take appropriate and fair corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
+code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
+will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is
+officially representing the community in public spaces. Examples of representing our community
+include using an official email address, posting via an official social media account, or acting as
+an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
+leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and
+investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any
+incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for
+any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
+unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the
+nature of the violation and an explanation of why the behavior was inappropriate. A public apology
+may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people
+involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
+specified period of time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate
+behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the
+community for a specified period of time. No public or private interaction with the people involved,
+including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including
+sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement
+of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing
+
+When contributing to this repository, please check our open issues and whether there is already an
+issue related to your idea. Please first discuss the change you wish to make in a GitHub issue and
+wait for a reply from the maintainers of this repository before making a change.
+
+We have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions relating
+to the project.
+
+## Environment setup
+
+To develop on your machine, install the following (and please submit issues if errors crop up)
+
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Docker](https://docs.docker.com/get-docker/)
+- [dprint](https://dprint.dev/)
+- [Just](https://github.com/casey/just)
+- [sql-formatter](https://github.com/sql-formatter-org/sql-formatter)
+- [insta](https://insta.rs/)
+
+## Pull requests
+
+**For a pull request to be merged it must at least:**
+
+:white_check_mark:   Pass CI
+
+:white_check_mark:   Have one approving review
+
+:white_check_mark:   Have the PR title follow
+[conventional commit](https://www.conventionalcommits.org/)
+
+**Ideally, a good pull request should:**
+
+:clock3:   Take less than 15 minutes to review
+
+:open_book:   Have a meaningful description (describes the problem being solved)
+
+:one:   Introduce one feature or solve one bug at a time, for which an open issue already
+exists. In case of a project wide refactoring, a larger PR is to be expected, but the reviewer
+should be more carefully guided through it
+
+:jigsaw:   Issues that seem too big for a PR that can be reviewed in 15 minutes or PRs that
+need to touch other issues should be discussed and probably split differently before starting any
+development
+
+:dart:   Handle renaming, moving files, linting and formatting separately (not alongside
+features or bug fixes)
+
+:test_tube:   Add tests for new functionality
+
+**Draft pull requests for early feedback are welcome and do not need to adhere to any guidelines.**
+
+When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews
+should finish with approval unless there are issues that would result in:
+
+:x:   Buggy behavior
+
+:x:   Undue maintenance burden
+
+:x:   Measurable performance issues
+
+:x:   Feature reduction (i.e. it removes some aspect of functionality that a significant
+minority of users rely on)
+
+:x:   Uselessness (i.e. it does not strictly add a feature or fix a known issue)
+
+:x:   Disabling a compiler feature to introduce code that wouldn't compile
+
+## Releases
+
+Declaring formal releases remains the prerogative of the project maintainer(s).
+
+## License
+
+By contributing to project, you agree that your contributions will be licensed under its
+[Apache license](LICENSE).
+
+## Changes to this arrangement
+
+This is an experiment and feedback is welcome! This document may also be subject to pull-requests or
+changes by contributors where you believe you have something valuable to add or change.
+
+## Testing
+
+### Ensure Test DB Accessible
+
+- **Stop PostgreSQL**: To stop the PostgreSQL instance:
+
+  ```bash
+  just pg-down
+  ```
+
+- **Restart PostgreSQL**: To restart without reinitializing the database (useful if the database is
+  already set up):
+
+  ```bash
+  just pg-up
+  ```
+
+> You only need to reinitialize the database if you want the latest data dump.
+
+### Run Tests
+
+```bash
+cargo test
+```
+
+### Update Snapshots
+
+```
+cargo insta review
+```