Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

58 lines (34 loc) · 2.54 KB

Contributing to MindAnchor

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to MindAnchor. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check a few things:

  • Search the Issues: Check if the issue has already been reported.
  • Update to the Latest Version: Bugs may already be fixed in the latest release.

Submitting a Bug Report

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

Before creating enhancement suggestions, please check a few things:

  • Search the Issues: Your idea might already be suggested or in progress.
  • Update to the Latest Version: Check if the feature has already been added.

Submitting a Pull Request

  • Fork the Repo: Create your own fork of the project.
  • Create a Branch: Make a branch for your change.
  • Test Your Changes: Ensure your changes work as expected.
  • Create a Pull Request: Submit your PR and describe your changes.

Style Guide

Git Commit Messages

  • 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: Ideal for GitHub and other tools.

Code Style

  • Follow PEP 8: For Python code, adhere to the PEP 8 style guide.
  • Comment Your Code: Write clear comments for complex code.
  • Write Tests: Include tests for your code.

Attribution

This document was adapted from the CONTRIBUTING.md template by PurpleBooth.