Skip to content

Contributing.md

Latest commit

 

History

History
174 lines (118 loc) · 4.3 KB

Contributing.md

File metadata and controls

174 lines (118 loc) · 4.3 KB

📌 CONTRIBUTING.md

Contributing to LocalMind

Thank you for your interest in contributing to LocalMind 🎉
We truly appreciate your time and effort. Contributions of all kinds are welcome — whether it’s fixing bugs, adding features, improving documentation, enhancing UI/UX, or refactoring code.

This guide outlines the best practices to help you contribute smoothly and effectively.

🌟 Why Contribute?

By contributing to LocalMind, you help:

  • Improve the project’s stability and features
  • Make the codebase more beginner-friendly
  • Support an open and collaborative developer community
  • Gain real-world open-source experience

🛠️ Contribution Workflow

1. Fork the Repository

Create your own copy of the LocalMind repository by clicking the Fork button on GitHub.
All changes should be made in your fork, not directly in the main repository.

2. Clone Your Fork

Clone the forked repository to your local system and navigate into the project directory.

git clone https://github.com/<your-username>/LocalMind.git
cd LocalMind

3. Create a New Branch

Always create a new branch for your work.
Choose a branch name that clearly describes the change you’re making.

Recommended branch naming conventions:

  • feature/add-search-bar
  • fix/api-error
  • docs/update-contributing
  • refactor/navbar-component

This helps maintain clarity and clean version control.

git checkout -b feature-name

4. Make Your Changes

While working on your changes:

  • Follow the existing project structure and conventions
  • Keep code readable and well-organized
  • Add comments where logic may be unclear
  • Update or add documentation if your change introduces new behavior
  • Test your changes before committing

5. Commit Your Changes

Write clear, concise, and meaningful commit messages.

Commit message best practices:

  • Use the imperative mood (e.g., “Add”, “Fix”, “Improve”)
  • Keep the first line short and descriptive
  • Avoid vague messages like “update” or “changes”

Examples of good commit messages:

  • Add dark mode toggle to navbar
  • Fix broken route in frontend
  • Improve error handling for login API
  • Update README with setup instructions

6. Push to Your Fork

Push your branch to your forked repository on GitHub.

git push origin feature-name

7. Open a Pull Request (PR)

Once your changes are pushed:

  • Navigate to your fork on GitHub
  • Click Compare & pull request
  • Set the base branch to main (original repository)
  • Set the compare branch to your feature branch

In the PR description:

  • Clearly explain what you changed
  • Explain why the change is necessary
  • Reference any related issues (if applicable)
  • Add screenshots or screen recordings for UI changes

🧪 Coding Standards & Best Practices

Please ensure that your contribution:

  • Uses consistent formatting and naming conventions
  • Avoids committing generated, build, or system files
  • Does not introduce unnecessary dependencies
  • Keeps functions and components modular and reusable

If your change affects core functionality, explain the impact clearly in the PR.

📄 Documentation & Configuration Contributions

If your contribution involves files such as:

  • README.md
  • LICENSE
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • Configuration or workflow files

Please ensure:

  • Markdown formatting is clean and readable
  • File names follow standard conventions
  • Content is accurate, concise, and helpful
  • The PR clearly explains the purpose of the update

🔄 Keeping Your Fork Up to Date

To avoid conflicts, regularly sync your fork with the upstream repository before starting new work.

git remote add upstream https://github.com/original-owner/LocalMind.git
git fetch upstream
git checkout main
git merge upstream/main
git push origin main

🤝 Community & Support

If you need help or have questions:

  • Open a GitHub Issue
  • Start a Discussion in the repository
  • Ask for clarification in an existing issue or PR

We encourage respectful communication and collaboration.

💖 Thank You!

Every contribution — big or small — makes a difference.
Thank you for helping improve LocalMind and being part of our open-source journey!

Happy coding 🚀