Stable 0.5.0

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI fmt clippy and test
+name: CI
 
 on:
   pull_request:
@@ -33,4 +33,4 @@ jobs:
         uses: actions/checkout@v4
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
-      - run: cargo test --all-features
+      - run: cargo test --all-features

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Deploy Docs to GitHub Pages
+name: Docs
 
 on:
   push:

.github/workflows/release.yml

@@ -132,7 +132,7 @@ jobs:
             ghcr.io/commit-boost/pbs:latest
           cache-from: type=registry,ref=ghcr.io/commit-boost/pbs:buildcache
           cache-to: type=registry,ref=ghcr.io/commit-boost/pbs:buildcache,mode=max
-          file: docker/pbs.Dockerfile
+          file: provisioning/pbs.Dockerfile
 
   build-and-push-signer-docker:
     runs-on: ubuntu-latest
@@ -166,7 +166,7 @@ jobs:
             ghcr.io/commit-boost/signer:latest
           cache-from: type=registry,ref=ghcr.io/commit-boost/signer:buildcache
           cache-to: type=registry,ref=ghcr.io/commit-boost/signer:buildcache,mode=max
-          file: docker/signer.Dockerfile
+          file: provisioning/signer.Dockerfile
 
   finalize-release:
     needs:

.gitignore

@@ -13,4 +13,5 @@ target/
 cb.docker-compose.yml
 targets.json
 .idea/
-logs
+logs
+.vscode/

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributors Guide
+
+Commit-Boost is community driven and we welcome all contributions.
+
+If you contribute to this repo, your contributions will be made to the project under both [Apache 2.0](/LICENSE-APACHE) and the [MIT](/LICENSE-MIT)
+license.
+
+There are fundamentally three ways you can contribute:
+
+1. **By opening an issue:** For example, if you believe that you have uncovered a bug
+2. **By adding context:** Providing additional context to existing issues
+3. **By resolving issues:** For example by opening a PR
+
+### Contributions Related to Spelling and Grammar
+
+For first-time contributors we will not be accepting PRs that only fix spelling or grammatical errors in documentation, code or
+elsewhere.
+
+### Submitting a bug report
+
+If you believe you have found a security issues, please **do not** open a public issue but check out our [Security](/SECURITY.md) policy instead.
+
+If you find a non-security related bug, please file an issue detailing:
+- Release version you are using
+- Code snippets and/or logs that can help identifying the bug 
+- Concrete steps to reproduce the bug
+
+### Submitting a feature request
+If you have a suggestion for a new feature or an improvement to an existing one, please open a new issue and provide:
+
+- A clear and concise description of the feature you’d like to see implemented.
+- An explanation of why this feature would be helpful or what problem it would solve.
+- Any relevant examples, mock-ups, or references that can help illustrate your idea.
+
+We value your input and appreciate all suggestions to help make this project better!
+
+### Resolving an issue
+We welcome PRs from any community member. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance.
+This will increase the likelihood of the PR getting merged.