Skip to content

Latest commit

 

History

History
91 lines (55 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

91 lines (55 loc) · 2.95 KB
Raw

Contributing to Price-Analyzer

Thank you for your interest in contributing to Price-Analyzer! Your contributions help improve the project and provide more value to the community. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

1. Reporting Issues

If you encounter any issues or bugs, please open an issue on the GitHub Issues page. Provide as much detail as possible, including:

  • A clear description of the problem.
  • Steps to reproduce the issue.
  • Any relevant error messages or screenshots.

2. Requesting Features

If you have ideas for new features or improvements, please open a feature request on the GitHub Issues page. Be sure to include:

  • A clear and concise description of the feature.
  • The problem it solves or the benefit it provides.
  • Any relevant context or examples.

3. Contributing Code

To contribute code, follow these steps:

  1. Fork the Repository

    Click the "Fork" button on the top right of the repository page to create a copy of the project in your GitHub account.

  2. Clone Your Fork

    git clone https://github.com/your-username/price-analyzer.git
cd price-analyzer

  3. Create a Branch

    Create a new branch for your changes:

    git checkout -b my-feature-branch

  4. Make Your Changes

    Make your changes or additions to the codebase. Ensure your code follows the project's coding style and conventions.

  5. Write Tests

    If applicable, add tests for your changes to ensure they work as expected and don't introduce new issues.

  6. Commit Your Changes

    Commit your changes with a clear and concise message:

    git add .
git commit -m "Add feature XYZ"

  7. Push Your Changes

    Push your branch to your forked repository:

    git push origin my-feature-branch

  8. Open a Pull Request

    Go to the GitHub repository and open a pull request (PR). Provide a detailed description of your changes and any relevant context.

Code Style and Guidelines

  • Code Style: Follow the existing code style and formatting conventions used in the project.
  • Documentation: Update relevant documentation if your changes affect the project's functionality or usage.
  • Testing: Ensure that all existing and new tests pass. Add new tests if necessary.

Reviewing and Merging

  • Pull requests will be reviewed by the maintainers. Feedback and requests for changes may be provided.
  • Once your pull request has been reviewed and approved, it will be merged into the main branch.

Additional Resources

Thank you for contributing to Price-Analyzer! Your help is greatly appreciated.