Skip to content

Latest commit

 

History

History
57 lines (29 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

57 lines (29 loc) · 2.48 KB
Raw

Contributing to Awesome Monitoring

Thank you for your interest in contributing to Awesome Monitoring! We welcome contributions from the community to help make this repository even better.

How to Contribute

Adding a New Tool or Resource

If you want to add a new monitoring tool or resource to the repository, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch in your forked repository to work on the addition.

  3. Make your changes by adding the new tool/resource to the appropriate category in the README.md file.

  4. Ensure that the new content is in Markdown format and follows the existing style.

  5. Double-check that all links are working correctly.

  6. Commit your changes and push them to your fork.

  7. Submit a pull request (PR) from your branch to the main repository.

  8. Wait for the maintainers to review your contribution. We'll do our best to review PRs in a timely manner.

Updating Existing Content

If you find outdated information or want to improve the existing content, feel free to submit a PR with the changes. Follow the same steps as mentioned above for creating a PR.

Guidelines

To ensure a smooth review process and maintain consistency in the repository, please adhere to the following guidelines:

  1. Be Relevant: Only add tools and resources related to monitoring, observability, and related topics.

  2. Use Markdown: All contributions should be written in Markdown format.

  3. Provide Descriptions: For each new tool/resource, include a brief description that explains what it does and why it's valuable.

  4. Use Link Shorteners: Avoid using link shorteners; use the direct links to the official websites or documentation.

  5. Organize Appropriately: Add new tools/resources to the appropriate category. If needed, you can suggest new categories in your PR.

  6. Be Respectful: Respect the opinions and ideas of other contributors. Be kind and considerate in all interactions.

  7. Verify Links: Ensure that all links are accurate and lead to the intended destinations.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please ensure that all interactions are in line with the Code of Conduct.

License

By contributing to Awesome Monitoring, you agree that your contributions will be licensed under the same LICENSE as the repository.

We appreciate your contributions and thank you for helping to make monitoring awesome together!