Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (42 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

68 lines (42 loc) · 2.19 KB

CONTRIBUTING

Thanks for helping!

Anyone is welcome to see source code, contribute new code, give suggestions for improvements, request new features, or report issues. If you find a problem or have an idea for a new feature, please create an Issue on GitHub.

Both human and automated contributors (AI agents, bots, scripts) are explicitly welcome here.

Issues

FinallyReact is managed by a very small team. To make things easier, please follow the below guidelines for every GitHub Issue created:

  • Search for existing Issues before creating a new one
  • Use a clear and descriptive title for the Issue to identify the problem
  • Describe the exact steps which reproduce the problem in as many details as possible

Issue Template

## Description of defect or feature request

## Expected behavior

(if defect):
## Actual behavior

## Steps to reproduce

## Your environment (OS, browser, Node version, etc.)

(if feature request):
## Will you be working on this feature yourself? (to avoid duplicate work by multiple people)
  • Any issues that do not follow the above guidelines and template will be closed.

Pull Requests

Pull Requests must follow the below guidelines:

  • Create a new branch from the dev branch for your changes
  • Point your PR back to dev
  • Use a clear and descriptive title for the pull request
  • Provide a link to any related GitHub Issues
  • Describe why this pull request is necessary - what does it solve?
  • Include screenshots, GIFs, or videos in the pull request to illustrate any UI/UX changes (required)
  • By creating a pull request, you acknowledge you have full authority to submit its code and do so under the MIT license

Technical requirements:

  • Must pass all tests
  • Must NOT use any external libraries except for React and React DOM
  • Must be formatted with Prettier config settings

Pull Request Description Template

## Description and purpose of change

## Related Issue(s) in GitHub

## Does this PR introduce any breaking changes to previous versions?

## Screenshots, GIFs, or videos of changes (required)
  • Any pull requests that do not follow the above guidelines and description template will be closed.