Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.29 KB

contributing.md

File metadata and controls

80 lines (53 loc) · 3.29 KB
Raw

Contributing to DoodleFix

Welcome to DoodleFix! We appreciate your interest in contributing. Before you get started, please take a moment to review the following guidelines.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Aviral Katiyar.

How to Contribute

We welcome contributions in the form of bug reports, feature requests, and pull requests.

Reporting Bugs

Before reporting a bug, please check if it has already been reported in the issue tracker. If not, please open a new issue, providing detailed information about the bug, including steps to reproduce it.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue to discuss it first. We appreciate your feedback and would love to hear your suggestions.

Pull Requests

  1. Fork the repository and create a new branch for your contribution.
  2. Make your changes and ensure the code is properly formatted.
  3. Write tests to cover your changes.
  4. Make sure all tests pass.
  5. Open a pull request, providing a clear and concise description of your changes.
  6. Ensure that your pull request adheres to the coding guidelines and includes a reference to the related issue (if applicable).

Development Setup

To contribute to DoodleFix, you need to have the following prerequisites installed on your system:

  1. Python 3.8 or higher: Download and install Python if you haven't already.

  2. Poetry: We use Poetry for dependency management. Install it by following the instructions here.

Once you have the prerequisites, you can set up the development environment by following these steps:

  1. Clone the repository:

    git clone https://github.com/maskboyAvi/AdobeGensolve.git

  2. Navigate to the project directory:

    cd AdobeGensolve

  3. Install dependencies using Poetry:

    poetry install

For a more detailed setup guide, consult our documentation.

If you encounter any issues during the setup process, please refer to the documentation or open an issue in the issue tracker.

Coding Guidelines

Follow the guidelines mentioned in our Coding Standards to maintain a consistent coding style.

Commit Message Guidelines

Please follow the conventional commits format for your commit messages.

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE file of this repository.

Thank you for contributing!