Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) · 3.92 KB

Contribution Guidelines for ShareStore

Thank you for your interest in contributing to ShareStore! We appreciate your help in making this project better. Before you start, please read these guidelines to understand how you can contribute effectively.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Code of Conduct
  4. Coding Standards
  5. License

Getting Started

To get started with ShareStore, follow these steps:

  1. Fork the Repository: Click the “Fork” button at the top right of the repository page to create a copy of the repository in your GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine using: 
    git clone https://github.com/your-username/ShareStore.git
  3. Set Upstream Remote: Add the original repository as a remote to keep your fork up to date: 
    git remote add upstream https://github.com/aqib-m31/ShareStore.git

How to Contribute

Reporting Issues

If you encounter a bug or issue, please follow these steps to report it:

  1. Check Existing Issues: Before creating a new issue, check if it has already been reported.
  2. Create a New Issue: Click on the “Issues” tab and then the “New Issue” button. Please provide the following details:
    • A clear and descriptive title.
    • A detailed description of the issue, including steps to reproduce, expected behavior, and any relevant screenshots or error messages.
    • The version of the software you are using.

Feature Requests

We welcome feature requests! To suggest a new feature:

  1. Check Existing Requests: Look through the existing feature requests to see if yours has already been suggested.
  2. Create a New Feature Request: If your idea is unique, open a new issue and include:
    • A descriptive title.
    • A detailed description of the feature, its benefits, and any potential use cases.

Submitting Code

If you want to contribute code, please follow these steps:

  1. Create a New Branch: Always create a new branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  2. Make Your Changes: Implement your changes locally.
  3. Write Tests: If applicable, write tests to cover your changes.
  4. Commit Your Changes: Commit your changes with a descriptive commit message: 
    git commit -m "Add feature: your feature description"
  5. Update Documentation: If your changes affect the documentation, please update the relevant README or documentation files.
  6. Push Your Changes: Push your changes to your fork: 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Navigate to the original repository on GitHub, click on the “Pull Requests” tab, and then the “New Pull Request” button. Select your branch and provide a clear description of your changes.

Review Process

Once you submit your pull request, the maintainers will review your changes. Here’s what to expect:

  • Feedback: You may receive comments and requests for changes.
  • Merge: Once your pull request is approved, it will be merged into the main branch.

Code of Conduct

We adhere to a Code of Conduct to ensure a welcoming environment for all contributors. Please read it here.

Coding Standards

To maintain the quality of the codebase, please follow these coding standards:

  • Consistent Formatting
  • Comment Your Code: Provide clear comments for complex logic.
  • Follow Naming Conventions: Use descriptive names for variables and functions.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.