Skip to content

Latest commit

 

History

History
158 lines (123 loc) · 6.28 KB

CONTRIBUTING.md

File metadata and controls

158 lines (123 loc) · 6.28 KB
Raw

HelpOps-Hub Contributing Guidelines

Thank you for taking the time to contribute to DevOps World. Your help is essential for keeping it great.

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 🪜

Note

This is Next.js project. You must have installed Node.js on your local macahine. If you don't have it installed yet,
you can download it from here.

Follow these steps to setup HelpOps-Hub on your local machine 👇

  • Fork the repository

  • Clone the forked repository in your local system.

     git clone https://github.com/<your-github-username>/HelpOps-Hub.git

  • Navigate to the website3.0 folder if you want to contribute to our website.

     cd website3.0

  • Now install dependency

     npm install

  • Run the Deployment Server

     npm run dev

  • Open http://localhost:3000 with your browser to see the result.

  • Create a new branch for your feature.

     git checkout -b <your_branch_name>

  • Perform your desired changes to the code base.

  • Track and stage your changes.

     # Track the changes
  git status

 # Add changes to Index
  git add .

  • Commit your changes.

    git commit -m "your_commit_message"

  • Push your committed changes to the remote repo.

    git push origin <your_branch_name>

  • Go to your forked repository on GitHub and click on Compare & pull request.

  • Add an appropriate title and description to your pull request explaining your changes and efforts done.

  • Click on Create pull request.

  • Congrats! 🥳 You've made your first pull request to this project repo.

  • Wait for your pull request to be reviewed and if required suggestions would be provided to improve it.

  • Celebrate 🥳 your success after your pull request is merged successfully.

Note

All images must be in webp or avif format, not png, jpeg, jpg, or others. This practice applies to the entire repository.

Use freeconvert.com to convert images to the required webp or avif formats.

💡 Want to contribute some documents related DevOps?

  • Just crate new folder in the root directory according to your requirement
  • and write everythig step by step in your own language in README.md
  • And then commit changes
  • Append new Documentation of Installation or anything
  • Append new DevOps Tools
  • Adding or Updating category description
  • And more!

🧑‍💻 Engage in Discussions

Join our community discussions to share insights and collaborate with others:

  • Visit the Forum: Head over to our community forum.
  • Participate Actively: Engage in ongoing discussions or start new ones on topics you're passionate about.

✅ Guidelines for Good Commit Messages

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. Be Concise and Descriptive: Summarize the change in a way that’s easy to understand at a glance.
  2. Use the Imperative Mood: Write as if giving a command (e.g., Add, Fix, Update), which is a convention in many projects.
  3. Include Context: Provide context or reason for the change if it’s not immediately obvious from the summary.
  4. Reference Issues and Pull Requests: Include issue numbers or PR references if the commit addresses them.
  5. Issue reference (Optional): Include the issue number associated with the commit (e.g., #123).

📝 Commit Message Examples ✅

Adding New Tools or Resources

  • Add - Jenkins setup guide to CI/CD section
  • Include - Terraform best practices in infrastructure as code
  • Add - Kubernetes cheat sheet to containerization

Fixing Errors or Bugs

  • Fix - typo in Docker installation guide
  • Correct - broken link in Ansible playbook documentation
  • Resolve - issue #42: Misleading description in Helm chart guide

Updating Existing Content

  • Update - Jenkins pipeline examples with new syntax
  • Revise - Docker security best practices
  • Refresh - CI/CD tools comparison chart

Enhancing Documentation

  • Improve - readability of Kubernetes deployment tutorial
  • Add - examples to Terraform variable documentation
  • Enhance - troubleshooting section in Prometheus guide

General Maintenance

  • Refactor - README for better clarity
  • Reorganize repository structure for easier navigation
  • Remove - outdated CI/CD tools from recommendations

❌ 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)"
  • If something is missing here, or you feel something is not well described, please raise an issue.