Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (25 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 2.03 KB

Contributing to Invoice Generator

Thank you for your interest in contributing to the Invoice Generator project! We welcome and appreciate all contributions, whether they are bug reports, new feature ideas, or code changes.

Please take a moment to review this document to make the contribution process as smooth as possible.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to rishabhmishra0510@gmail.com.

How to Contribute

Found a Bug?

  1. Check existing issues: Before creating a new issue, please check if a similar bug has already been reported.
  2. Report the bug: If not, open a new issue and provide a clear and descriptive title.
  3. Describe the steps to reproduce: Include as much detail as possible, including your operating system, browser, and steps to replicate the issue.

Suggesting a Feature

  1. Check existing issues/discussions: Search for existing feature requests to avoid duplicates.
  2. Open a new issue: Use a clear and descriptive title.
  3. Explain the problem: Describe the problem you're trying to solve or the need for this feature.
  4. Describe the solution: Propose how the new feature could be implemented or how it should work.

Submitting a Pull Request

  1. Fork the repository and create your branch from master.
  2. Make your changes: Follow the project's coding style and conventions. Write clear commit messages.
  3. Test your changes: Ensure that your changes do not break existing functionality. Run pytest for the backend and manually test the frontend.
  4. Create a pull request:
    • Provide a clear title and description of the changes.
    • Reference any related issues (e.g., Fixes #123).
    • Be patient! A maintainer will review your work and may provide feedback.

Development Setup

See the README.md file for instructions on how to set up the development environment.