Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 2.57 KB

Contributing to FastAPI React Starter

First off, thank you for considering contributing to FastAPI React Starter! It's people like you that make this project such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use the GitHub issue search — check if the issue has already been reported.
  • Check if the issue has been fixed — try to reproduce it using the latest main branch.
  • Use the bug report template when creating an issue.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Use the GitHub issue search — check if the enhancement has already been suggested.
  • Use the feature request template when creating an issue.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the style guides
  • Include appropriate test cases
  • Document new code

Styleguides

Git Commit Messages

We use AI-generated commit messages following these guidelines:

  • Start with a short sentence in imperative form, no more than 50 characters long
  • Leave an empty line and continue with a more detailed explanation
  • The first part should be only one sentence
  • The detailed explanation should be two or three sentences at most
  • Avoid overly verbose descriptions or unnecessary details

Example:

Add user authentication functionality

Implement JWT-based authentication system with login and registration endpoints.
Add middleware for protected routes and user session management.

JavaScript Styleguide

  • Use semicolons
  • 2 spaces for indentation
  • Prefer const over let or var
  • Use meaningful variable names

Python Styleguide

  • Follow PEP 8
  • Use 4 spaces for indentation
  • Use meaningful variable names

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that represent a bug in the codebase
  • documentation - Issues related to documentation
  • enhancement - Issues that represent new feature requests
  • good first issue - Issues that are good for newcomers
  • help wanted - Issues that need assistance from the community

Thank you for contributing!