Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.57 KB

contributing.md

File metadata and controls

61 lines (40 loc) · 1.57 KB

Contributing to LinuxAdminToolkit

How to Contribute

  1. Fork the Repository 🍴
  • Start by forking the repository to your GitHub account.
  • This creates the copy of the repository where you can make changes.
  1. Clone the Fork 🖥️
  • Clone your forked repository to your local machine.
git clone https://github.com/yourusername/LinuxAdminToolkit.git
cd LinuxAdminToolkit
  1. Create a Branch 🌿
  • Create a new branch for your work.
  • Use a descriptive name for the branch to identify the content update.
git checkout -b branch-name
  1. Make Your Changes ✍️
  • Make the necessary changes in your branch.
  • Ensure your content is well-documented and follows the repository's style guidelines.
  1. Commit Your Changes 💾
  • Commit your changes with a clear and descriptive commit message.
git add .
git commit -m "Add a detailed description of your changes"
  1. Push to Your Fork 🚀
  • Push your changes to your forked repository on GitHub.
git push origin branch-name
  1. Create a Pull Request 🔄
  • Navigate to the original repository on GitHub and create a pull request from your fork and branch.
  • Provide a clear and detailed description of your changes.

Guidelines 📃

  • Follow the existing code style and conventions.
  • Ensure your documentation is clear, concise, and easy to understand.
  • Provide examples where applicable.
  • Ensure that any new content is relevant to Linux administration.
  • Organize content in the appropriate sections (Commands, Shell Scripting, Configuration Files, etc.).