chore: merge develop into main (#49)

Co-authored-by: Giwook Han <[email protected]>
Co-authored-by: Jihoon Song <[email protected]>
Co-authored-by: beast <[email protected]>
Co-authored-by: t-botclive <[email protected]>
Co-authored-by: guiltygyoza <[email protected]>

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+
+[*.rs]
+max_line_length = 100
+indent_size = 4

.env.example

@@ -0,0 +1,2 @@
+# Optional. If this env is not set then default value will be '.ramd'
+RAMD_DIR_NAME=".ramd2"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Logs**
+If applicable, add logs to help explain your problem. (Please submit them as text.)
+
+**System information**
+ - OS & version: [e.g. Windows 11 Pro / Ubuntu 18.04 LTS / macOS 11 Big Sur]
+ - Commit hash: 
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the problem you are trying to solve**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Describe why the solution is optimal**
+A clear and concise description of the rationale for the solution you're proposing.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/lint.yml

@@ -0,0 +1,45 @@
+name: fmt and clippy check
+
+env:
+  CARGO_TERM_COLOR: always
+
+on:
+  pull_request:
+
+jobs:
+  test_and_lint:
+    name: Run linters
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cargo/bin
+            ~/.cargo/git/checkouts
+            ~/.cargo/git/db
+            ~/.cargo/registry/cache
+            ~/.cargo/registry/index
+            target
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.77.2
+          override: true
+          components: rustfmt, clippy
+
+      - name: Run cargo clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: -- -D warnings
+
+      - name: Run cargo fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check

.github/workflows/project-management.yml

@@ -0,0 +1,26 @@
+name: Add issues to Project Management dashboard
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.TOPOLOGY_APP_ID }}
+          private-key: ${{ secrets.TOPOLOGY_APP_PEM }}
+
+      - uses: actions/[email protected]
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+        with:
+          project-url: https://github.com/orgs/topology-foundation/projects/1
+          github-token: ${{ steps.generate-token.outputs.token }}

.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+
+**/*.rs.bk
+
+target/
+
+.vscode/
+.idea/
+*.iml
+
+.cargo-ok
+
+# Default database directory
+/gram-database
+
+.env

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to RAM Monorepo
+
+Thank you for considering improvements to RAM monorepo! We are always happy to receive contributions across a broad spectrum, such as:
+
+- Reporting new issues.
+- Enhancing documentation.
+- Fixing bugs.
+- Implementing new features.
+
+To contribute, please open a PR with your changes for review. For more complex changes, we recommend identifying an existing issue or creating a new one and sync with the maintainers to prevent any wasted efforts or duplication.
+
+## Finding an Issue
+
+You may find an existing issue that interests you. To facilitate our journey, please communicate with the maintainers before starting work on it.
+
+If you have an idea and cannot find a related issue, feel free to open one. Before doing so, please consider:
+
+- Does a similar issue already exist?
+- Is the issue being proposed clearly explained?
+- Is the issue important and sufficiently prepared to ask the community to spend time reviewing?
+
+Please avoid opening issues to ask questions. Instead, use our [Discord](https://discord.gg/hMsQas3Vw9) for inquiries.
+
+## Opening a Pull Request
+
+All changes must be submitted as a PR and approved by the maintainers. For your PR, please ensure that:
+
+- The branch name should follow [git flow](https://nvie.com/posts/a-successful-git-branching-model/).
+- The PR should have a descriptive title and detailed content.
+- The PR should pass all tests and linters.
+
+In our effort to maintain healthy code, we kindly ask you to review:
+
+- Correctness: Is the change well-designed and does it function correctly and efficiently?
+- Comprehension: Can others easily understand the change? Remember, code is read many more times than it is written. It's often helpful to use the maxim “the customer is always right.”
+- Consistency: Does the change adhere to agreed-on best practices for that particular programming language and remain consistent with the existing codebase?
+- Attribution: If the change borrows code from other open sources, it must comply with their licensing and attribute credit appropriately.
+
+## The Review Process
+
+All PRs must go through the review process that involves:
+
+- The maintainers, including other collaborators, may leave comments, ask questions and offer suggestions. Further changes can be made by pushing additional commits to the same branch.
+- We aim to foster a culture of trust and respect. Please be polite and professional.
+- During the process, other PRs that conflict with yours may be merged. Please resolve these conflicts by applying those changes to your branch.
+- When the PR is ready for review again, leaving a comment mentioning the reviewers would help resume the process.
+- The reviewers can indicate a PR is ready for merging by approving it. Approved PRs will then be merged by the maintainers.
+- Please be responsive to discussions and modifications to help the review process proceed in a timely fashion.