Skip to content

Latest commit

 

History

History
112 lines (75 loc) · 5.02 KB

CONTRIBUTING.md

File metadata and controls

112 lines (75 loc) · 5.02 KB

Contributing to MLOGS

Welcome to MLOGS, your ultimate blogging platform! We appreciate your interest in contributing to our project. Whether you're a developer, designer, writer, or simply enthusiastic about blogging, there are several ways you can help improve MLOGS. This guide will help you get started.

Table of Contents

Code of Conduct

Before you start contributing, please review our Code of Conduct. We are committed to fostering an open and welcoming community, and we expect contributors to adhere to our guidelines.

How Can I Contribute?

1. Reporting Bugs

If you encounter a bug or issue while using MLOGS, please report it using the GitHub Issue Tracker. When creating an issue, make sure to include:

  • A clear and descriptive title.
  • A detailed description of the bug, including steps to reproduce it.
  • Information about your environment, such as operating system, browser, and version.

2. Suggesting Enhancements

If you have ideas for improvements or new features, you can suggest them by opening a new issue in the GitHub Issue Tracker. Please provide:

  • A clear and concise title.
  • A detailed description of your suggestion or enhancement.
  • Any relevant information that could help us understand and implement the idea.

3. Pull Requests

We welcome contributions in the form of pull requests (PRs). Here's how to contribute code to MLOGS:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Implement the changes in your branch.
  4. Ensure that your code follows our Coding Guidelines.
  5. Test your changes thoroughly.
  6. Write clear and concise commit messages.
  7. Open a pull request against the main branch of the mlogs-backend repository.
  8. Participate in the review process and address any feedback.
  9. Once your PR is approved, it will be merged.

Setting Up the Development Environment

To set up your development environment for MLOGS, follow the instructions in the README.md. This document provides details on project dependencies and setup.

Coding Guidelines

Please follow our coding guidelines and maintain consistent code style to ensure code quality. These guidelines include:

  • Indentation and code formatting.
  • Naming conventions.
  • Comments and documentation.
  • Best practices for performance and security.

Commit Message Guidelines

For clarity and maintainability, we follow specific commit message guidelines:

  • Prefix with a suitable category, using lowercase:

    • feat: For adding new features
    • fix: For bug fixes
    • chore: For routine tasks like maintenance or refactoring
    • docs: For documentation changes
    • style: For formatting, linting, or styling changes (no code changes)
    • test: For adding or modifying tests

    Example:

    feat: add user profile functionality

  • Use sentence case for the commit message. Start with a concise, one-line summary in the present tense (e.g., feat: add login authentication).

  • Avoid formatting errors by ensuring that the codebase passes all linting, formatting, and validation checks before committing.

  • Provide additional context if necessary. After the summary line, leave a blank line and add a detailed description on the following lines.

Branching Strategy

We use a branching strategy to manage code changes:

  • The main branch represents the stable release.
  • For features or bug fixes, create feature branches.
  • For hotfixes, create hotfix branches.

Testing

We maintain a robust testing suite to ensure code quality and stability. If you contribute code, please write tests for your changes and make sure that all tests pass before submitting a pull request.

Documentation

Documentation is crucial for understanding and maintaining the project. If you update code, please also update relevant documentation, including comments, README.md, and API documentation.

Community

MLOGS is about building a community and collaborating with passionate contributors. Join our community discussions, ask questions, and share your ideas on our GitHub Discussions.

Thank you for considering contributing to MLOGS. Your help is essential to making this platform better for everyone!