Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 3.16 KB
Raw

Contributing to ProjectName

Thank you for considering contributing to Monica! We welcome contributions of all kinds, including bug reports, feature requests, and code improvements. This guide will help you get started.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Setup
  4. Style Guide
  5. Commit Messages
  6. Pull Request Process
  7. Acknowledgements

Code of Conduct

This project and everyone participating in it are governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub and include as much detail as possible. The following information can help us resolve the issue faster:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual results.
  • Any relevant logs, screenshots, or other supporting information.

Suggesting Features

We welcome feature suggestions! To suggest a new feature, please open an issue on GitHub with the following details:

  • A clear and descriptive title.
  • A detailed description of the feature and its potential benefits.
  • Any relevant examples or mockups.

Submitting Changes

If you want to make a change to the codebase, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your changes (git checkout -b feature/my-new-feature).
  3. Make your changes.
  4. Commit your changes with a clear and concise commit message.
  5. Push your branch to your forked repository (git push origin feature/my-new-feature).
  6. Open a pull request on the main repository.

Development Setup

Prerequisites

Installation

  1. Clone the repository: git clone https://github.com/username/ProjectName.git
  2. Navigate to the project directory: cd monuica

Style Guide

Please adhere style guides to maintain consistency in the codebase:

  • go lint

Commit Messages

Write meaningful commit messages following these guidelines:

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Pull Request Process

  1. Ensure your changes pass all tests and linters.
  2. Update documentation as needed.
  3. Ensure your pull request description clearly explains the problem and solution.
  4. Reference any related issues in your pull request description.
  5. Request a review from one of the project maintainers.

Acknowledgements

Thank you to all the contributors who have helped make this project better. Your support and involvement are greatly appreciated!

We look forward to your contributions! If you have any questions, feel free to reach out to us