Merge pull request #23 from privacy-scaling-explorations/chore/cleanup

Minor issues & cleanup

Author: 0xjei

.commitlintrc.js

@@ -2,12 +2,11 @@ const fs = require("node:fs")
 const path = require("node:path")
 
 const packages = fs.readdirSync(path.resolve(__dirname, "packages"))
-const apps = fs.readdirSync(path.resolve(__dirname, "apps"))
 
 module.exports = {
     extends: ["@commitlint/config-conventional"],
     prompt: {
-        scopes: [...packages, ...apps],
+        scopes: [...packages],
         markBreakingChangeMode: true,
         allowCustomIssuePrefix: false,
         allowEmptyIssuePrefix: false,

.eslintignore

@@ -23,10 +23,6 @@ dist
 build
 /docs
 
-# Docusaurus cache and generated files
-.docusaurus
-.cache-loader
-
 # misc
 .DS_Store
 *.pem

.github/workflows/main.yml

@@ -37,8 +37,6 @@ jobs:
                   files_yaml: |
                       contracts:
                         - packages/contracts/**/*.{js,json,ts,sol}
-                      docs:
-                        - apps/docs/**/*
                       packages:
                         - packages/**/*.{js,json,ts}
                         - '!packages/{contracts}/**/*'
@@ -53,12 +51,6 @@ jobs:
                   yarn compile:contracts
                   yarn workspace excubiae-contracts lint
 
-            - if: steps.changed-files.outputs.docs_any_changed == 'true'
-              name: Build and format docs
-              run: |
-                  yarn workspace excubiae-docs build
-                  yarn workspace excubiae-docs format
-
             - if: steps.changed-files.outputs.packages_any_changed == 'true'
               name: Build packages
               run: yarn build:packages

.gitignore

@@ -65,10 +65,6 @@ build
 dist
 /docs
 
-# Docusaurus cache and generated files
-.docusaurus
-.cache-loader
-
 # Hardhat
 artifacts
 cache

.prettierignore

@@ -26,10 +26,6 @@ build
 # github
 .github/ISSUE_TEMPLATE
 
-# Docusaurus cache and generated files
-.docusaurus
-.cache-loader
-
 # mdx file
 *.mdx
 

.yarn/releases/yarn-4.5.0.cjs

@@ -1,9 +1,9 @@
-yarnPath: .yarn/releases/yarn-4.5.0.cjs
-
 checksumBehavior: update
 
 compressionLevel: mixed
 
 enableGlobalCache: false
 
 nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.6.0.cjs

.yarn/releases/yarn-4.6.0.cjs

@@ -0,0 +1,127 @@
+# 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, 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 e-mail 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.
+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.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.yarnrc.yml

@@ -0,0 +1,113 @@
+# Contributing
+
+:tada: Thank you for being interested in contributing to the Excubiae project! :tada:
+
+Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
+
+All members of our community are expected to follow our [Code of Conduct](/CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
+
+We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
+
+## Issues
+
+The best way to contribute to our projects is by opening a [new issue](https://github.com/semaphore-protocol/semaphore/issues/new/choose) or tackling one of the issues listed [here](https://github.com/semaphore-protocol/semaphore/contribute).
+
+## Pull Requests
+
+Pull requests are great if you want to add a feature or fix a bug. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests.
+
+3. Add a test for your change. Only refactoring and documentation changes require no new tests.
+
+4. Make sure to check out the [Style Guide](/CONTRIBUTING.md#style-guide) and ensure that your code complies with the rules.
+
+5. Make the test pass.
+
+6. Commit your changes.
+
+7. Push to your fork and submit a pull request on our `main` branch. Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.
+
+> [!IMPORTANT]
+> We do not accept minor grammatical fixes (e.g., correcting typos, rewording sentences) unless they significantly improve clarity in technical documentation. These contributions, while appreciated, are not a priority for merging. If there is a grammatical error feel free to message the team.
+
+## CI (Github Actions) Tests
+
+We use GitHub Actions to test each PR before it is merged.
+
+When you submit your PR (or later change that code), a CI build will automatically be kicked off. A note will be added to the PR, and will indicate the current status of the build.
+
+## Style Guide
+
+### Code rules
+
+We always use ESLint and Prettier. To check that your code follows the rules, simply run the npm script `yarn lint`.
+
+### Commit rules
+
+For commits it is recommended to use [Conventional Commits](https://www.conventionalcommits.org).
+
+Don't worry if it looks complicated, in our repositories, `git commit` opens an interactive app to create your conventional commit.
+
+Each commit message consists of a **header**, a **body** and a **footer**. The **header** has a special format that includes a **type**, a **scope** and a **subject**:
+
+    <type>(<scope>): <subject>
+    <BLANK LINE>
+    <body>
+    <BLANK LINE>
+    <footer>
+
+The **header** is mandatory and the **scope** of the header must contain the name of the package you are working on.
+
+#### Type
+
+The type must be one of the following:
+
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
+- perf: A code change that improves the performance
+- test: Adding missing or correcting existing tests
+- build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
+- ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
+- chore: Other changes that don't modify src or test files
+- revert: Reverts a previous commit
+
+#### Scope
+
+The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).
+
+#### Subject
+
+The subject contains a succinct description of the change:
+
+- Use the imperative, present tense: "change" not "changed" nor "changes"
+- Don't capitalize the first letter
+- No dot (.) at the end
+
+#### Body
+
+Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
+
+### Branch rules
+
+- There must be a `main` branch, used only for the releases.
+- Avoid long descriptive names for long-lived branches.
+- Use kebab-case (no CamelCase).
+- Use grouping tokens (words) at the beginning of your branch names (in a similar way to the `type` of commit).
+- Define and use short lead tokens to differentiate branches in a way that is meaningful to your workflow.
+- Use slashes to separate parts of your branch names.
+- Remove branch after merge if it is not important.
+
+Examples:
+
+```bash
+git branch -b docs/readme
+git branch -b test/a-feature
+git branch -b feat/sidebar
+git branch -b fix/b-feature
+```

CODE_OF_CONDUCT.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Privacy & Scaling Explorations
+Copyright (c) 2025 Privacy & Scaling Explorations
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

CONTRIBUTING.md

@@ -6,10 +6,10 @@ It provides a set of abstract and flexible smart contracts, known as "gatekeeper
 
 This approach enables seamless interoperability across different protocols. For instance, a single check could combine verifiable attributes from Semaphore and MACI, ensuring flexible and composable access control. Indeed, for example, you can define criteria to verify token ownership and/or validate a zero-knowledge proof (ZKP). Using these criteria, you can create a policy to enforce the checks and integrate it seamlessly into your smart contract logic. A practical use case might involve requiring verification before registering a new voter for a poll (e.g., in a MACI-based voting system).
 
-You can learn more in this [design document](https://hackmd.io/@0xjei/B1RXoTh71e).
+You can learn more in this [technical reference document](https://hackmd.io/@0xjei/B1RXoTh71e).
 
 > [!IMPORTANT]  
-> Excubiae is currently in the MVP stage. Official documentation and audits are not yet available. Expect fast development cycles with potential breaking changes — use at your own risk!
+> Excubiae is currently in the MVP stage. Official documentation website and audits are not yet available. Expect fast development cycles with potential breaking changes — use at your own risk! Please, refer to [release](https://github.com/privacy-scaling-explorations/excubiae/releases) section for latest changes and updates.
 
 ## Installation
 
@@ -59,7 +59,7 @@ yarn test
 
 ### Build
 
-Build all packages & apps:
+Build all packages:
 
 ```bash
 yarn build