Skip to content

contributing.md

Latest commit

 

History

History
129 lines (74 loc) · 2.41 KB

contributing.md

File metadata and controls

129 lines (74 loc) · 2.41 KB
Raw

📌 CONTRIBUTING.md

Contributing to LocalMind

Thank you for your interest in contributing to LocalMind! We welcome all contributions — bug fixes, new features, documentation improvements, or even small cleanups.

Please follow the guidelines below to help us keep the project organized, consistent, and easy for everyone to work with.

🛠️ How to Contribute

1. Fork the Repository

Click the Fork button on GitHub to create your own copy of this repository.

2. Clone Your Fork

git clone https://github.com//LocalMind.git cd LocalMind

3. Create a New Branch

Create a branch that describes your change:

git checkout -b feature-name

Examples:

  • add-license
  • fix-path-error
  • improve-readme
  • add-ui-component

4. Make Your Changes

  • Add or update necessary files.
  • Keep code style clean and consistent.
  • If adding a feature, include relevant documentation.

5. Commit Your Changes

Use meaningful commit messages:

git add . git commit -m "Short description of the change"

Good examples:

  • Add MIT license
  • Fix missing environment variable issue
  • Improve error handling in backend API

6. Push to Your Fork

git push origin feature-name

7. Open a Pull Request (PR)

  • Go to your fork on GitHub.
  • Click Compare & pull request.
  • Choose base: main (original repo) compare: feature-name (your branch)
  • Add a clear description of the changes.

🧪 Coding Guidelines

  • Follow consistent formatting and naming.
  • Write clear comments where needed.
  • Avoid committing temporary or system-generated files.
  • If your change affects functionality, explain the reason in the PR.

📄 Adding License or Documentation Changes

If you are contributing files such as:

  • LICENSE
  • README.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md

Make sure:

  • File names follow standard naming.
  • Text is clearly formatted in Markdown.
  • The PR explains why the document is being added or updated.

🧵 Keeping Your Fork Updated

Before starting new work, sync your fork:

git fetch upstream git checkout main git merge upstream/main git push origin main

❓ Need Help?

If you have questions or want guidance:

  • Open an Issue on GitHub
  • Or start a discussion in the repository

We are happy to help!

Thank you again for contributing to LocalMind ❤️ Your efforts help make this project better for everyone!