Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

122 lines (80 loc) · 4.06 KB

ShellScript-Toolkit Contributing Guidelines

Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:

⚠️IMPORTANT

Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.

An automated process has been implemented to ensure the timely management of Pull Requests (PRs) on this platform.

PRs that have been open for a duration exceeding 45 days will be automatically closed, so please plan accordingly.

Prerequisites ⚠️

  • Open Source Etiquette: If you've never contributed to an open source project before, have a read of Basic etiquette for open source projects.

  • Basic familiarity with Git and GitHub: If you are also new to these tools, visit GitHub for complete beginners for a comprehensive introduction to them.

How to Contribute 🤔

To get started, look at the existing create a new issue!

Setup guidelines 🪜

Follow these steps to setup ShellScript-Toolkit on your local machine

  1. Fork the repository

  2. Clone the project to run on your local machine using the following command:

    git clone https://github.com/<your_github_username>/ShellScript-Toolkit.git

  3. Get into the root directory

    cd ShellScript-Toolkit
    1. Create your branch
    git checkout -b <your_branch_name>
  • After all completion then push and then create pull request

  1. Make your changes before staging them.

  2. Stage your changes

    git add <filename>

  3. Commit your changes

    git commit -m "<your-commit-message>"

  4. Push your changes to your branch

    git push origin "<your_branch_name>"

  5. Create a PULL REQUEST 💣

    Click compare across forks if you don't see your branch

Commits Message Guidelines 💬

We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines:

  1. Type: The commit type must be one of the following:

    • Folder: Write folder of the name like- Ubuntu,redhat etc.
    • Tools: For adding new tools
    • ShellScript: Edit
    • style: Code style changes (e.g., formatting, semicolons).
    • refactor: Code refactorings with no feature changes or bug fixes.
    • test: Adding or improving tests.
    • chore: General maintenance tasks, build changes, etc.

  2. Scope (Optional): The scope provides context for the commit, indicating the specific part of the project being affected. Use a short description in lowercase (e.g., auth, navbar, README).

  3. Description: A brief and meaningful description of the changes made. Start with a capital letter and use the imperative mood (e.g., "Add new feature" instead of "Added new feature").

  4. Issue reference (Optional): Include the issue number associated with the commit (e.g., #123).

✔️ Examples of Valid Commit Messages

  • Folder: Add new folder for all DevOps tools
  • Tools: Adding new tools-nane
  • ShellScript: Edit some of the shellscrits for enhancement
  • style: Format code according to project guidelines
  • refactor(navbar): Improve responsiveness
  • test: Add unit tests for API endpoints
  • chore: Update dependencies to latest versions
  • fix: Handle edge case in data processing (#456)

❌ Examples of Invalid Commit Messages

  • Added new stuff
  • Fixed a bug
  • Updated code
  • auth feature update
  • chore: fixed some stuff

Commit Example with Commitlint

git commit -m "feat(auth): Implement user signup process (#789)"