Merge pull request #148 from afonsofrancof/contributing_documentation

Added CONTRIBUTING.md and changed README.md

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# 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. Setting Up Your Development Environment
+
+1. **Clone the repo**: Start by cloning the Linutil repository to your local machine.
+   ```bash
+   git clone https://github.com/christitustech/linutil.git
+   cd linutil
+   ```
+2. **Install Rust**: Make sure you have Rust installed on your machine. If you don't, you can install it by following the instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
+3. **Edit the files you want to change**: Make your changes to the relevant files.
+4. **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
+
+## 2. Make Meaningful Changes
+
+- **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.
+
+## 3. 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.
+
+## 4. 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.
+
+## 5. 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.
+
+## 6. 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.
+
+## 7. 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.
+
+## 8. Documentation
+
+- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
+
+## 9. 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!

README.md

@@ -5,27 +5,34 @@
 
 ![Preview](docs/assets/preview.png)
 
-A distro-agnostic* toolbox which helps with everyday Linux tasks. It can help you set up applications and your system for specific use cases! Written with Rust 🦀
+**Linutil** is a distro-agnostic toolbox designed to simplify everyday Linux tasks. It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust 🦀, providing performance and reliability.
 
-\* — The project is in active development, so there could be some issues. Please consider [submitting feedback](https://github.com/ChrisTitusTech/linutil/issues).
+*Note:* Since the project is still in active development, you may encounter some issues. Please consider [submitting feedback](https://github.com/ChrisTitusTech/linutil/issues) if you do.
 
 ## 💡 Usage
 
-Open your terminal and paste this command:
+To get started, open your terminal and run the following command:
 ```bash
 curl -fsSL https://christitus.com/linux | sh
 ```
+## 💖 Support
+
+If you find Linutil helpful, please consider giving it a ⭐️ to show your support!
 
 ## 🎓 Documentation
-### [LinUtil Official Documentation](https://christitustech.github.io/linutil/)
 
-## 💖 Support
+For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://christitustech.github.io/linutil/).
-To morally and mentally support the project, make sure to leave a ⭐️!
 
-## 🏅 Thanks to all Contributors
+## 🛠 Contributing
-Thanks a lot for spending your time helping Linutil grow. Keep rocking 🍻.
+
+We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
+
+## 🏅 Thanks to All Contributors
+
+Thank you to everyone who has contributed to the development of Linutil. Your efforts are greatly appreciated, and you’re helping make this tool better for everyone!
 
 [![Contributors](https://contrib.rocks/image?repo=ChrisTitusTech/linutil)](https://github.com/ChrisTitusTech/linutil/graphs/contributors)
 
-## Credits
+## 📜 Credits
-Rust Shell written by [@JustLinuxUser](https://github.com/JustLinuxUser)
+
+Linutil’s Rust shell was developed by [@JustLinuxUser](https://github.com/JustLinuxUser).