braidpool · mcelrath · Apr 28, 2025 · Mar 27, 2025 · Mar 27, 2025 · Mar 28, 2025
diff --git a/.githooks/pre-commit b/.githooks/pre-commit
@@ -0,0 +1,5 @@
+#! /bin/sh 
+
+echo "This runs before the commit to test frontend linting!"
+cd dashboard
+npm run pre-commit
diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml
@@ -0,0 +1,21 @@
+name: Prettier
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "*"
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20.x"
+      - run: npm ci
+        working-directory: dashboard
+      - run: npx prettier --check .
+        working-directory: dashboard
diff --git a/.github/workflows/rustfmt.yml b/.github/workflows/rustfmt.yml
@@ -0,0 +1,21 @@
+name: Rust Format Check
+
+on: [push, pull_request]
+
+jobs:
+  rustfmt:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        components: rustfmt
+
+    - name: Run rustfmt
+      run: cargo fmt -- --check
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+# Welcome to BraidPool contributing guide
+
+Thank you for investing your time in contributing to our project!
+
+In this guide, you will get an overview of a contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
+
+## New contributor guide
+
+To get an overview of the project, read the [documentations of BraidPool](./docs/).
+
+### Issues
+
+#### Create a new issue
+
+If you spot a problem with the project, [search if an issue already exists](https://github.com/braidpool/braidpool/issues). If a related issue doesn't exist, you can open a new issue using a relevant issue form.
+
+#### Solve an issue
+
+Scan through our [existing issues](https://github.com/braidpool/braidpool/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, and after discussion, it comes out to be a valid issue, you are welcome to open a PR with a fix.
+
+### Make Changes
+
+1. Fork the repository.
+
+   - Using GitHub Desktop:
+
+     - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
+     - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
+
+   - Using the command line:
+     - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
+
+2. Create a new working branch and start with your changes!
+
+### Commit your updates
+
+Commit the changes once you are happy with them.
+
+- Note: The commits being made to dev branch [should be signed using a PGP key](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
+
+#### 1. For Dashboard Development:
+
+Please follow these rules or conventions while committing any new changes to the [Braidpool dashboard](./dashboard/):
+
+- `feat`: new feature for the user, not a new feature for build script
+- `fix`: bug fix for the user
+- `docs`: changes to the documentation
+- `style`: formatting, missing semi colons, etc
+- `refactor`: refactoring production code, eg. renaming a variable
+- `test`: adding missing tests, refactoring tests
+- `chore`: updating grunt tasks, etc., no production code change
+- Be sure to run `npx prettier --write .` before commiting so as to cross-check that the commits adhere to the linting scheme of the project's frontend
+
+#### 2. For Node Development:
+
+- TO-DO
+
+### Pull Request
+
+When you're finished with the changes, create a pull request, also known as a PR.
+
+- Don't forget to link PR to issue if you are solving one.
+- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
+- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is merged!
+
+Congratulations! once your PR is merged, your contributions will be publicly visible in [closed PRs](https://github.com/braidpool/braidpool/pulls?q=is%3Apr+is%3Aclosed).
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,3 +1,3 @@
 [workspace]
-members = ["node"]
+members = ["node", "braidpool-primitives"]
 resolver = "3"