Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

71 lines (56 loc) · 2.97 KB
Raw

Contributing to the Database Monitoring Project (MariaDB, MongoDB, PostgreSQL) with Grafana and Prometheus

Thank you for your interest in contributing to this database monitoring project! By following these guidelines, we can keep the workflow organized and efficient. All contributions are welcome, whether it's code, documentation, or suggestions.

How to contribute?

1. Report a bug

If you find a bug or unexpected behavior, please follow these steps:

  • Ensure the issue hasn’t already been reported.
  • Create a new issue with the following information:
    • A detailed description of the problem.
    • Steps to reproduce the issue.
    • Logs or error messages, if possible.
    • Your environment (OS, version of Prometheus, Grafana, and the database).

2. Suggest a new feature

Do you have an idea to improve the project? Awesome! We'd love to hear more:

  • Check that the feature hasn’t been suggested before.
  • Create a new issue describing the proposed feature.
  • Explain the benefit of this feature and if it affects other parts of the system.

3. Improve documentation

Clear documentation is key to any successful project. You can help by:

  • Reviewing the README.md and updating any outdated information.
  • Adding new usage examples.
  • Improving technical explanations.

4. Contribute code

If you're interested in adding new features or fixing bugs, follow these steps:

Step 1: Fork the repository

Fork this repository to your personal GitHub account.

Step 2: Create a new branch

In your forked repository, create a new branch to work on your contribution:

git checkout -b my-new-feature

Step 3: Make your changes

Make the necessary changes in your branch and ensure to follow these guidelines:

  • Follow the project’s coding style.
  • Add or update tests as needed.
  • Ensure that changes do not break the system by using the configured CI tools.

Step 4: Submit a pull request

Once your changes are ready:

  1. Make sure everything works correctly.
  2. Commit your changes and push your branch: 
    git add .
git commit -m "Description of my contribution"
git push origin my-new-feature
  3. Create a Pull Request to the main or develop branch of the original repository.

5. Review pull requests

If you'd like to help review others’ contributions, feel free to do so under the "Pull Requests" tab. Be sure to provide constructive feedback.

Code Style

Please ensure that your code follows the project’s style:

  • Use descriptive variable and function names.
  • Follow the coding conventions for the language you're working with (Java for Spring Boot, Python for Django, etc.).
  • Comment your code when necessary for clarity.

Code of Conduct

Our project adheres to a code of conduct to ensure all contributions take place in a collaborative and respectful environment.

If you have any questions, feel free to create an issue or reach out to us. Thank you for your collaboration!