Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (71 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

112 lines (71 loc) · 2.91 KB

📜 CONTRIBUTING.md

Thank you for considering contributing to Learning Prometheus! 🚀
Your contributions are highly appreciated and help make this project better for everyone.

🛠 How to Contribute?

📌 1. Fork the Repository

Click the Fork button on the top-right corner of this repository to create your own copy.

📌 2. Clone Your Fork

Open your terminal and run:

git clone https://github.com/your-username/Learning-Prometheus.git

Replace your-username with your GitHub username.

📌 3. Navigate to the Project Directory

cd Learning-Prometheus

📌 4. Create a New Branch

Before making changes, create a new branch:

git checkout -b feature-branch

Replace feature-branch with a relevant branch name.

📌 5. Make Your Changes

Modify the code, update documentation, or add new Prometheus configurations.

📌 6. Commit Your Changes

Follow best practices for writing meaningful commit messages:

git commit -m "✨ Added PromQL query examples for better monitoring"
  • Use present-tense verbs (e.g., "Add" instead of "Added")
  • Keep commit messages concise yet descriptive

📌 7. Push the Changes

git push origin feature-branch

📌 8. Open a Pull Request (PR)

  • Navigate to the original repository (NotHarshhaa/Learning-Prometheus).
  • Click on New Pull Request.
  • Select your forked repository and the branch you worked on.
  • Write a clear PR description explaining your changes.
  • Submit the PR for review. 🎉

📝 Contribution Guidelines

✔️ Follow proper code formatting and best practices.
✔️ Add meaningful commit messages.
✔️ Write detailed PR descriptions explaining the changes.
✔️ Ensure new contributions are well-documented.
✔️ Test your code before submitting a PR.
✔️ For documentation updates, maintain proper formatting and clarity.

🐞 Reporting Issues

If you find a bug, have a feature request, or want to suggest an improvement:

  1. Check existing issues to avoid duplicates.
  2. Open a new issue with:
    • A descriptive title
    • Steps to reproduce the bug
    • Expected vs. actual behavior
    • Any screenshots or logs (if applicable)

🌎 Community & Support

👥 Join our discussion and ask questions in our Telegram community:
📢 Join Telegram

💡 Follow me on GitHub for more DevOps content:
⭐ GitHub Profile

🙌Acknowledgments

This project is maintained by Harshhaa.
Thank you for being part of the DevOps & Prometheus community! 💙

✅ Now you are ready to contribute! Happy coding! 🚀