From 740fa0db4a80ce2ac81d08422763947c89a19830 Mon Sep 17 00:00:00 2001 From: <> Date: Thu, 24 Oct 2024 19:46:11 +0000 Subject: [PATCH] Deployed c0982a7 with MkDocs version: 1.6.0 --- contributing/index.html | 2 +- search/search_index.json | 2 +- sitemap.xml.gz | Bin 127 -> 127 bytes 3 files changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing/index.html b/contributing/index.html index a38af0d2..d6a963d1 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -1 +1 @@ - Contributing Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

Contributing Guide

\n\n# Contributing Guidelines for Linutil

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

1. Install Rust:

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

2. Fork and Clone the repo

  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil

3. Make your changes

  • Edit the files you want to change: Make your changes to the relevant files.
  • Test your changes: Run cargo run to test your modifications in a local environment and ensure everything works as expected.

4. Understand the existing code

  • Have a clear reason: Don’t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it’s necessary and how it improves the project.
  • Respect existing conventions: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.

5. Learn from Past Pull Requests (PRs)

  • Check merged PRs: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
  • Study rejected PRs: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.

6. Write Clean, Descriptive Commit Messages

  • Be descriptive: Your commit messages should clearly describe what the change does and why it was made.
  • Use the imperative mood: For example, "Add feature X" or "Fix bug in Y", rather than "Added feature X" or "Fixed bug in Y".
  • Keep commits clean: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.

7. Keep Your Pull Requests (PRs) Small and Focused

  • Make small, targeted PRs: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
  • Avoid combining unrelated changes: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.

8. Understand and Test the Code You Write

  • Review your code: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project.
  • Avoid using LLMs: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards.
  • Testing Requirements: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.

9. Code Review and Feedback

  • Expect feedback: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
  • Participate in reviews: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.

10. Contributing Is More Than Just Code

  • Test the tool: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
  • Write well-formed issues: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
  • Propose reasonable feature requests: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.

11. Documentation

  • Update the documentation: If your change affects the functionality, please update the relevant documentation files to reflect this.

12. License

  • Agree to the license: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

\ No newline at end of file + Contributing Guide - Chris Titus LinUtil Official Documentation
Skip to content
Announcement: This documentation is still in progress.

Contributing Guide

\n\n# Contributing Guidelines for Linutil

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

1. Install Rust:

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

2. Fork and Clone the repo

  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil

3. Make your changes

  • Edit the files you want to change: Make your changes to the relevant files.
  • Test your changes: Run cargo run to test your modifications in a local environment and ensure everything works as expected.

4. Understand the existing code

  • Have a clear reason: Don’t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it’s necessary and how it improves the project.
  • Respect existing conventions: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.

5. Learn from Past Pull Requests (PRs)

  • Check merged PRs: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
  • Study rejected PRs: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.

6. Write Clean, Descriptive Commit Messages

  • Be descriptive: Your commit messages should clearly describe what the change does and why it was made.
  • Use the imperative mood: For example, "Add feature X" or "Fix bug in Y", rather than "Added feature X" or "Fixed bug in Y".
  • Keep commits clean: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.

7. Keep Your Pull Requests (PRs) Small and Focused

  • Make small, targeted PRs: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
  • Avoid combining unrelated changes: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.

8. Understand and Test the Code You Write

  • Review your code: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project.
  • Avoid using LLMs: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards.
  • Testing Requirements: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.

9. Code Review and Feedback

  • Expect feedback: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
  • Participate in reviews: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.

10. Contributing Is More Than Just Code

  • Test the tool: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
  • Write well-formed issues: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
  • Propose reasonable feature requests: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.

11. Documentation

  • Update the documentation: If your change affects the functionality, please update the relevant documentation files to reflect this.
  • Automatic generation: If you decide to add functionality through a new shell script, make sure to fill out all fields in tab_data.toml and run cargo xtask docgen.

12. License

  • Agree to the license: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

\ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json index d50ca280..2b5d5ee9 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":""},{"location":"#installation","title":"Installation","text":"

LinUtil is also available as a package in various repositories:

Arch Linux LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: - `linutil` - Stable release compiled from source - `linutil-bin` - Stable release pre-compiled - `linutil-git` - Compiled from the last commit (not recommended) by running:
git clone https://aur.archlinux.org/<package>.git\ncd linutil\nmakepkg -si\n
Replace `` with your preferred package. If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler:
paru -S linutil\n
Replace `paru` with your preferred helper and `linutil` with your preferred package. Cargo LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
cargo install linutil\n
Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contributing/","title":"Contributing Guide","text":"

\\n\\n# Contributing Guidelines for Linutil

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

"},{"location":"contributing/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contributing/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contributing/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contributing/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contributing/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contributing/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contributing/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contributing/#8-understand-and-test-the-code-you-write","title":"8. Understand and Test the Code You Write","text":""},{"location":"contributing/#9-code-review-and-feedback","title":"9. Code Review and Feedback","text":""},{"location":"contributing/#10-contributing-is-more-than-just-code","title":"10. Contributing Is More Than Just Code","text":""},{"location":"contributing/#11-documentation","title":"11. Documentation","text":""},{"location":"contributing/#12-license","title":"12. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"User Guide","text":""},{"location":"userguide/#walkthrough","title":"Walkthrough","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#developer-tools","title":"Developer Tools","text":""},{"location":"userguide/#communication-apps","title":"Communication Apps","text":""},{"location":"userguide/#office-suites","title":"Office Suites","text":""},{"location":"userguide/#pdf-suites","title":"PDF Suites","text":""},{"location":"userguide/#web-browsers","title":"Web Browsers","text":""},{"location":"userguide/#gaming","title":"Gaming","text":""},{"location":"userguide/#diablo-ii-resurrected","title":"Diablo II Resurrected","text":""},{"location":"userguide/#security","title":"Security","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-linux","title":"Arch Linux","text":""},{"location":"userguide/#fedora","title":"Fedora","text":""},{"location":"userguide/#utilities","title":"Utilities","text":""},{"location":"userguide/#monitor-control","title":"Monitor Control","text":""},{"location":"userguide/#user-account-manager","title":"User Account Manager","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"

To get started, run the following command in your terminal:

"},{"location":"#stable-branch","title":"Stable branch","text":""},{"location":"#curl-fssl-httpschristituscomlinux-sh","title":"
curl -fsSL https://christitus.com/linux | sh\n
","text":""},{"location":"#installation","title":"Installation","text":"

LinUtil is also available as a package in various repositories:

Arch Linux LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: - `linutil` - Stable release compiled from source - `linutil-bin` - Stable release pre-compiled - `linutil-git` - Compiled from the last commit (not recommended) by running:
git clone https://aur.archlinux.org/<package>.git\ncd linutil\nmakepkg -si\n
Replace `` with your preferred package. If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler:
paru -S linutil\n
Replace `paru` with your preferred helper and `linutil` with your preferred package. Cargo LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
cargo install linutil\n
Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))

After you've ran the command, you should see a GUI on your screen; It will look something like this:

Info

LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contributing/","title":"Contributing Guide","text":"

\\n\\n# Contributing Guidelines for Linutil

Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:

"},{"location":"contributing/#1-install-rust","title":"1. Install Rust:","text":"

Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.

"},{"location":"contributing/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
  1. Make a fork of the repo in GitHub
  2. Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contributing/#3-make-your-changes","title":"3. Make your changes","text":""},{"location":"contributing/#4-understand-the-existing-code","title":"4. Understand the existing code","text":""},{"location":"contributing/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":""},{"location":"contributing/#6-write-clean-descriptive-commit-messages","title":"6. Write Clean, Descriptive Commit Messages","text":""},{"location":"contributing/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":""},{"location":"contributing/#8-understand-and-test-the-code-you-write","title":"8. Understand and Test the Code You Write","text":""},{"location":"contributing/#9-code-review-and-feedback","title":"9. Code Review and Feedback","text":""},{"location":"contributing/#10-contributing-is-more-than-just-code","title":"10. Contributing Is More Than Just Code","text":""},{"location":"contributing/#11-documentation","title":"11. Documentation","text":""},{"location":"contributing/#12-license","title":"12. License","text":"

We appreciate your contributions and look forward to collaborating with you to make Linutil better!

"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":""},{"location":"roadmap/","title":"Roadmap","text":""},{"location":"roadmap/#vision","title":"Vision","text":""},{"location":"roadmap/#goals","title":"Goals","text":""},{"location":"roadmap/#milestones","title":"Milestones","text":""},{"location":"roadmap/#q3-2024","title":"Q3 2024","text":""},{"location":"roadmap/#q4-2024","title":"Q4 2024","text":""},{"location":"roadmap/#community-feedback","title":"Community Feedback","text":""},{"location":"userguide/","title":"User Guide","text":""},{"location":"userguide/#walkthrough","title":"Walkthrough","text":""},{"location":"userguide/#applications-setup","title":"Applications Setup","text":""},{"location":"userguide/#developer-tools","title":"Developer Tools","text":""},{"location":"userguide/#communication-apps","title":"Communication Apps","text":""},{"location":"userguide/#office-suites","title":"Office Suites","text":""},{"location":"userguide/#pdf-suites","title":"PDF Suites","text":""},{"location":"userguide/#web-browsers","title":"Web Browsers","text":""},{"location":"userguide/#gaming","title":"Gaming","text":""},{"location":"userguide/#diablo-ii-resurrected","title":"Diablo II Resurrected","text":""},{"location":"userguide/#security","title":"Security","text":""},{"location":"userguide/#system-setup","title":"System Setup","text":""},{"location":"userguide/#arch-linux","title":"Arch Linux","text":""},{"location":"userguide/#fedora","title":"Fedora","text":""},{"location":"userguide/#utilities","title":"Utilities","text":""},{"location":"userguide/#monitor-control","title":"Monitor Control","text":""},{"location":"userguide/#user-account-manager","title":"User Account Manager","text":""}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 2c84ee3e9a241291be01f7306eedacddb3a3c9f8..9ed08e15c07b872bc530a077f20c3506f32cea13 100644 GIT binary patch delta 13 Ucmb=gXP58h;9%&JoXB1Q02s9ccK`qY delta 13 Ucmb=gXP58h;9w|YnaExN02k>4N&o-=