Merge branch 'main' into release

# Conflicts:
#	Cargo.lock
#	Cargo.toml
#	java-bridge/Cargo.lock

.dockerignore

@@ -0,0 +1,19 @@
+target
+.git
+.github
+.devcontainer
+.fleet
+.vscode
+.gitignore
+.gitmodules
+.gitattributes
+.dockerignore
+.editorconfig
+.env
+.env.example
+.envrc
+.envrc.example
+.envrc.local
+.envrc.local.example
+.envrc.local.template
+.envrc.template

CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
+[email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+## How to contribute
+
+> [!IMPORTANT]  
+> **These steps are more particular to this repo but mainly apply to all repositories; change the specifics.**
+
+Unless you explicitly state otherwise, any Contribution intentionally submitted for inclusion in this project by you, as
+defined in the Apache License shall be dual-licensed as above, without any additional terms or conditions.
+
+1. Join the project's [slack](https://bit.ly/3UU1oXi) (this is for the `rencfs` project, please use the one for your project) and join the `#dev-beginners` channel (or any relevant ones)
+2. **Ask the owner of the repository to add your GitHub username to the repository** so that you can work on issues and
+   be able to create your own branches and not need to fork the repo
+
+# Devs & QA automation (which steps apply)
+
+3. Become familiar with docs and code by reading the [ramp-up](../docs/readme/Ramp-up.md) guide
+4. Pick an open issue or a task in the corresponding [project](https://github.com/users/radumarias/projects/1) for the
+   repo you'll work on. You can
+   see [good for first issues](https://github.com/xorio/rencfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+   that you can pick from
+5. **Assign the issues you are working on to you and move them to the corresponding status column as you progress
+   . If the task is not an issue yet, convert it to an issue first**
+6. Make the changes in your branch
+7. Add docs as they apply
+8. Add tests, benchmarks, and examples for your changes, if applicable
+9. `cargo fmt --all` to format the code. You can configure your `IDE` to do this on
+   save, [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html)
+   and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting)
+10. `cargo clippy --all --release` and fix any errors
+11. **DON'T INCREASE THE VERSION NUMBER IN `Cargo.toml`, WE WILL DO THAT WHEN RELEASING**
+12. Create a `git` `push hook` file in `.git/hooks/pre-push` with [pre-push](scripts/git-hooks/linux-macos/pre-push)
+    content
+    on `Linux` and `macOS`, and [pre-push](scripts/git-hooks/windows/pre-push) on `Windows`.
+    Make it executable in Linux and macOS
+    with `chmod +x .git/hooks/pre-push` .This will run when you do `git push` and will make the push quite
+    slow, but please give it time to complete as this helps to fix any issues locally and not rely just on
+    running `ci` on GitHub when you create the PR
+13. Commit the changes with the commit message following the [Commit Message Guidelines](https://gist.github.com/radumarias/5b5374f3ed022c99d617eb849aafd069)
+14. Push your changes, and if there are any errors, fix them before you push them
+15. Create a `PR` back to the `parent` repo targeting the `main` branch with the title as the GitHub issue title, including `#ID`. Also, include the link to the GitHub issue in the description, saying like `Fix for <link>` for bugs or `Implementation for <link>` for features and others
+16. Request review from owners of the repository by adding them to the `Reviewers` field
+17. After you create the PR, link it to the GH issue from the mid-right of the page, press the gear icon from the below image, select `xoriors/rencfs`, then write the issue number and select it. This will link the two, and when the PR is merged, it will close the issue too  
+  ![image](https://github.com/user-attachments/assets/5ac0313d-4175-44d1-8d1e-d18da773ab32)
+18. In the project, move the item to `In Code Review`
+19. Monitor the checks (GitHub actions runs) and fix the code if they are failing
+20. Respond to any comments
+21. **DON'T MERGE THE PR YOURSELF. LEAVE THAT TO REPOSITORY OWNERS**
+22. In the end, ideally, it will be merged into `main`
+
+# QA manual
+
+Please follow these [steps](../docs/readme/Testing.md).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,21 +17,26 @@ Steps to reproduce the behavior:
 3. Scroll down to '....'
 4. See error
 
+**Actual behavior**
+A clear and concise description of what you exaclty is happening.
+
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots or screen recordings**
+If applicable, add screenshots or screen recordings to help explain your problem.
+
+**Logs**
+Collectt last 100 lines from terminal and attach those to the issue.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
+ - Last 100 lines from logs
 
 **Smartphone (please complete the following information):**
  - Device: [e.g. iPhone6]
  - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
  - Version [e.g. 22]
 
 **Additional context**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,44 @@
+## Title
+
+If this is related to a GitHub issue, please have use the issue's title, inlcude `#ID` too.
+
+## Description
+
+Please include a summary of the changes and the related issue. Describe **why** this change is needed.
+
+Fixes # (issue)
+
+---
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+---
+
+## Checklist:
+
+- [ ] I have performed a self-review of my code
+- [ ] I have tested my code on different platforms (if applicable)
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have added necessary documentation (if appropriate)
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+---
+
+## Screenshots (if applicable)
+
+Add screenshots to illustrate changes if necessary.
+
+---
+
+## Additional Context
+
+Add any additional context or information here.

.github/SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.x.y   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+[Report a security vulnerability](https://github.com/radumarias/rencfs/security/advisories/new): Report a security vulnerability.

.github/SUPPORT.md

@@ -0,0 +1,13 @@
+# Support
+
+For any issues you might have, feel free to contact us on:
+- [email protected]
+- [slack](https://bit.ly/3UU1oXi) in the `#support` channel
+- [LinkedIn](https://www.linkedin.com/company/xorio)
+
+# Issues
+
+If you find any issues or vulnerabilities or you'd like a feature, please follow these steps:
+- [Open a bug](https://github.com/radumarias/rencfs/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=): Create a report to help us improve.
+- [Report a security vulnerability](https://github.com/radumarias/rencfs/security/advisories/new): Report a security vulnerability.
+- [Feature request](https://github.com/radumarias/rencfs/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=): Suggest an idea for this project.

.github/workflows/build_and_tests_reusable.yaml

@@ -51,12 +51,16 @@ jobs:
             -A clippy::type_complexity
         shell: bash
 
-      - name: doc
-        run: cargo doc --workspace --all-features --no-deps
-
       - name: tests
         if: matrix.os != 'windows-latest'
-        run: cargo test --release --all --all-features
+        run: cargo test --release --all --all-features -- --skip keyring
+
+      - name: bench
+        if: matrix.os != 'windows-latest'
+        run: cargo bench --workspace --all-targets --all-features -- --skip keyring
+
+      - name: doc
+        run: cargo doc --workspace --all-features --no-deps
 
       - name: test package
         if: matrix.os == 'ubuntu-latest'
@@ -82,6 +86,7 @@ jobs:
 
       - name: java-bridge clippy
         run: |
+          cd java-bridge
           cargo clippy --all-targets --release -- \
             -A clippy::similar_names \
             -A clippy::too_many_arguments \
@@ -91,11 +96,19 @@ jobs:
             -A clippy::type_complexity
         shell: bash
 
-      - name: java-bridge doc
-        run: cargo doc --workspace --all-features --no-deps
-
       - name: java-bridge tests
         if: matrix.os != 'windows-latest'
         run: |
           cd java-bridge
           cargo test --release --all --all-features
+
+      - name: java-bridge bench
+        if: matrix.os != 'windows-latest'
+        run: |
+          cd java-bridge
+          cargo bench --workspace --all-targets --all-features
+
+      - name: java-bridge doc
+        run: |
+          cd java-bridge
+          cargo doc --workspace --all-features --no-deps

.github/workflows/package_reusable.yaml

@@ -81,6 +81,7 @@ jobs:
       - name: build push = ${{ inputs.upload_artifacts }}
         uses: docker/build-push-action@v6
         with:
+          file: docker/Dockerfile
           push: ${{ inputs.upload_artifacts }}
           tags: ${{ env.REGISTRY_USER }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}
           sbom: true