Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

80 lines (53 loc) · 4.25 KB
Raw

How to contribute

So you're thinking about contributing to Fhi.Frontend.ReactComponents? Great! Maintaining and enhancing Fhi.Frontend.ReactComponents is a big job, so the community's help is really appreciated. Helping out isn't just writing code, it also includes submitting issues, helping confirm issues and improving the documentation.

Table of contents:

Submitting Issues

Requests for new features and bug reports keep the project moving forward.

Before you submit an issue

  • Ensure you are running the latest version of Fhi.Frontend.ReactComponents
  • Search the issue list (including closed issues) to make sure it hasn't already been reported.

Submitting a good issue

  • Give the issue a short, clear title that describes the bug or feature request
  • Include steps to reproduce the issue
  • If possible, include a short code example that reproduces the issue
  • Use markdown formatting as appropriate to make the issue and code more readable.

Confirming Issues

Before we work on issues, we must confirm them and be able to reproduce them. Confirming issues takes up a great deal of the team's time, so making that job easier is really appreciated.

Issues that need confirmation will have the confirm label or be unlabeled and have no milestone. You can help us to confirm issues by;

  • Add steps to reproduce the issue
  • Test issues and provide feedback

Documentation

Great documentation is essential for any open source project and Fhi.Frontend.ReactComponents is no exception. Our README often lags behind the features that have been implemented or would benefit from better examples.

PS. If you would like to contribute to creating an exended, and better, documentation in the form of a Wiki, help is really appreciated!

Fixing Bugs and Adding Features

We love pull requests, but would prefer that new contributors start with smaller issues and let us know before you contribute to prevent duplication of work.

It is also a good idea to add a comment to an issue that you are working on to let everyone know. If you stop working on it, also please let us know.

Pull request guidelines for

Feature branches

  1. Create a new branch named either feature/*, bugfix/* or hotfix/*
  2. Before pull request, remember to update CHANGELOG.md PS.If you are not releasing changes right away, add Unreleased instead of version number to CHANGELOG.md
  3. Push feature branch, create pull request with a good name, and a comment if necessary
  4. After approved review, squash and merge to main

Release branches

  1. Create a new branch named release/x.x.x
  2. Change text Unreleased to x.x.x i CHANGELOG.md
  3. Run npm version [patch, minor, major] to upgrade package.json
  4. Push release branch and create pull request
  5. After approved review, squash and merge to main (deploy)

License

Fhi.Frontend.ReactComponents is under the MIT license. By contributing to Fhi.Frontend.ReactComponents, you assert that:

  • The contribution is your own original work.
  • You have the right to assign the copyright for the work (it is not owned by your employer, or you have been given copyright assignment in writing).