Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (64 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

82 lines (64 loc) · 3.2 KB
Raw

Contributing to OneStore

First off, thank you for considering contributing to OneStore! It's people like you that make this project possible and ensure it can grow and improve. We appreciate your time and effort.

How to Contribute

Reporting Bugs

If you find a bug in the project, please create an issue on GitHub with as much detail as possible. Include steps to reproduce the bug, any relevant log output, and screenshots if applicable.

  1. Go to the Issues section of the repository.
  2. Click on New Issue.
  3. Add the Bug Report Tag.
  4. Fill out the template with the necessary details.

Suggesting Features

We are always looking for new ways to improve OneStore. If you have a feature request, please create an issue on GitHub detailing your idea.

  1. Go to the Issues section of the repository.
  2. Click on New Issue.
  3. Add the Feature Request Tag.
  4. Describe your feature in detail and explain why it would be beneficial.

Code Contributions

Fork the Repository

  1. Fork the repository by clicking the Fork button on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/Open-One-Store/OneStore.git
cd onestore

Set Up Your Environment

  1. Install the necessary dependencies for the part of the project you are working on (see the README.md for more details).
  2. Make sure everything is working by running the application locally.

Making Changes

  1. Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch
  2. Make your changes, following the existing code style and conventions.
  3. Test your changes thoroughly to ensure they do not break existing functionality.

Commit and Push

  1. Commit your changes with a clear and concise commit message: 
    git commit -m "Description of the feature or fix"
  2. Push your branch to your forked repository: 
    git push origin my-feature-branch

Create a Pull Request

  1. Go to the original repository on GitHub.
  2. Click on Compare & pull request.
  3. Ensure your branch is up to date with the base branch.
  4. Provide a detailed description of your changes and submit the pull request.

Code Style and Guidelines

  • Follow the existing coding style.
  • Write clear and concise comments where necessary.
  • Ensure your code passes existing tests and linting checks.

Reviewing Pull Requests

We welcome your help in reviewing pull requests. This is a great way to familiarize yourself with the codebase and help other contributors.

  1. Review the code changes.
  2. Test the new functionality or bugfix.
  3. Provide constructive feedback and suggestions via comments (either in-line or on the Pull Request)

Community Guidelines

  • Be respectful and inclusive.
  • Provide constructive feedback.
  • Be open to feedback and suggestions.
  • Help others when you can.

Thank You

Thank you for contributing to OneStore! Your support and contributions help make this project better for everyone. If you have any questions or need assistance, feel free to reach out to the maintainers or open a new issue on GitHub.

Happy coding!