Merge branch 'main' into encryptedfs_trait

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+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.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**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**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**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.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build_and_tests.yml → .github/workflows/build_and_tests.yaml

@@ -15,16 +15,16 @@ env:
 
 jobs:
   version:
-      uses: radumarias/rencfs/.github/workflows/version_reusable.yml@main
+      uses: radumarias/rencfs/.github/workflows/version_reusable.yaml@main
 
   build_and_test:
     name: build and test
-    uses: radumarias/rencfs/.github/workflows/build_and_tests_reusable.yml@main
+    uses: radumarias/rencfs/.github/workflows/build_and_tests_reusable.yaml@main
     secrets: inherit
 
   package:
     needs: [version, build_and_test]
-    uses: radumarias/rencfs/.github/workflows/package_reusable.yml@main
+    uses: radumarias/rencfs/.github/workflows/package_reusable.yaml@main
     with:
       upload_artifacts: false
       version: ${{ needs.version.outputs.version }}

.github/workflows/build_and_tests_reusable.yml → .github/workflows/build_and_tests_reusable.yaml

@@ -1,25 +1,31 @@
-name: '_reusable-build-and-tests-reusable'
+name: '_build-and-tests'
 on:
   workflow_call:
 
 env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: 0 # TODO: remove this when we cache the builds
-  
+
 jobs:
   tests:
     name: build and tests
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-      fail-fast: true    
+      fail-fast: true
     steps:
       - uses: actions/checkout@v4
 
+      - name: setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          components: rustfmt, clippy
+          profile: minimal
+
       - name: setup Rust
         run: |
-          rustup update
           cargo install cargo-aur
           cargo install cargo-generate-rpm          
 

.github/workflows/package_reusable.yml → .github/workflows/package_reusable.yaml

@@ -1,4 +1,4 @@
-name: '_reusable-package'
+name: '_package'
 on:
   workflow_call:
     inputs:
@@ -18,15 +18,24 @@ jobs:
       steps:
         - uses: actions/checkout@v4
 
-        - name: install latest Rust nightly
-          run: rustup default nightly && rustup update
-
-        - name: install cargo-aur
-          run: cargo install cargo-aur
+        - name: setup Rust
+          uses: actions-rs/toolchain@v1
+          with:
+            toolchain: nightly
+            components: rustfmt, clippy
+            profile: minimal
+
+        - name: setup Rust
+          run: |
+            cargo install cargo-aur
+            cargo install cargo-generate-rpm          
+
+        - name: run cargo aur and generate-rpm
+          if: matrix.os == 'ubuntu-latest'
+          run: |
+            cargo aur
+            cargo generate-rpm
 
-        - name: run cargo aur
-          run: cargo aur
-
         - name: check for publish
           run: cargo publish --dry-run --allow-dirty
 

.github/workflows/release.yml → .github/workflows/release.yaml

@@ -11,16 +11,16 @@ env:
 
 jobs:
   version:
-    uses: radumarias/rencfs/.github/workflows/version_reusable.yml@main
+    uses: radumarias/rencfs/.github/workflows/version_reusable.yaml@main
 
   build_and_test:
     name: build and test
-    uses: radumarias/rencfs/.github/workflows/build_and_tests_reusable.yml@main
+    uses: radumarias/rencfs/.github/workflows/build_and_tests_reusable.yaml@main
     secrets: inherit
 
   package:
     needs: [version, build_and_test]
-    uses: radumarias/rencfs/.github/workflows/package_reusable.yml@main
+    uses: radumarias/rencfs/.github/workflows/package_reusable.yaml@main
     with:
       upload_artifacts: true
       version: ${{ needs.version.outputs.version }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# 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 at
+[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
+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.

CONTRIBUTING.md

@@ -3,20 +3,22 @@
 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 [slack](https://join.slack.com/t/rencfs/shared_invite/zt-2o4l1tdkk-VJeWIbO2p6zgeafDISPHbQ)
-2. Become familiar with docs and code by reading the [ramp-up](Ramp-up.md)
-3. **Ask the owner of the repository to add your GitHub username to the repository**
+2. Become familiar with docs and code by reading the [ramp-up](Ramp-up.md) guide
+3. **Ask the owner of the repository to add your GitHub username to the repository** os that you can work on issues and be able to create your own branches and not needing to fork the repo
 4. Pick an open issue or a task in the corresponding [project](https://github.com/users/radumarias/projects/1) for the repo that you'll be working on. You can see [good for first issues](https://github.com/radumarias/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 are working on them. If the taks is not an issue yet, convert it to issue first**
+5. **Assign the issues you are working on to you and move them to the corresponding status column as you are progressing on them. If the taks is not an issue yet, convert it to 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
+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 erorrs
 11. **DON'T INCREASE THE VERSION NUMBER IN `Cargo.toml`, WE WILL DO THAN WHEN RELEASING**
-12. **MAKE SURE YOU RUN THIS BEFORE PUSHING TO THE REPO `./check-before-push-linux.sh`, `./check-before-push-macos.sh` or `cmd /c check-before-push-windows.bat` and fix any errors**
-13. Create a **PR** back to the **parent** repo targeting the `main` branch and request review from owners of the repository
-14. Monitor the checks (GitHub actions runs) and fix the code if they are failing
-15. Respond to any comments
-16. In the end, ideally, it will be merged to `main`
+12. Create a `git` `commit hook` file in `.git/hooks/pre-commit` with [this](hooks/linux-macos/pre-commit) content on `Linux` and `MacOS`, or [this](hooks/windows/pre-commit) on `Windows`. Make it executable in Linux and macO with `chmod +x .git/hooks/pre-commit` .This will run when you do `git commit` and will make the commit to be quite slow, but please give it time to complete as this helps to fix any issues locally and not relying just on running `ci` on GitHub when you create the PR
+13. Commit your changes and if there are any errors fix them before you push them
+14. Push your changes and create a `PR` back to the `parent` repo targeting the `main` branch and request review from owners of the repository
+15. Monitor the checks (GitHub actions runs) and fix the code if they are failing
+16. Respond to any comments
+17. **DON'T MERGE THE PR YOURSELF, LEAVE THAT TO REPOSITORY OWNERS**
+18. In the end, ideally, it will be merged to `main`