Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 2.03 KB

Contributing to Enform

👏 Thank you for contributing

We are all busy with jobs, family or hobbies, but also want to spend some time on open source. Time is limited resource, though, so this short guide is here to make contribution productive:

⌨︎ Working with the codebase

Before opening a PR:

  • check if what you are planning to work on is in open issues
  • if not, open a new one and attach some labels (check below)
  • if it's there - join the discussion
  • go ahead with your PR

🐞 Bug report

If you are about to open new bug report issue try to be more specific about things like version, browser, OS, steps. Don't forget to attach the bug label.

Ideally, provide codesandbox example 🙏. Fork the basic demo if that will make it easy for you. More examples to fork from are available on docs page.

💡 Feature request

It is good to start working on new features based on issues/discussion and not opened PR in order to avoid closing irrelevant ones. Creating an issue with feature request label is a good starting point.

❓ If you have a question

Check the docs first. May be you will find the answer there. How about the open issues - did someone already ask the same? If not feel free to create new issue and attach the question label.

🏷 Issue labels/tags

Mark your issues with the following lables where it make sense:

  • bug - for bug reports
  • feature request - if you want that functionality
  • question - want to ask about something
  • help wanted - if you need help with the code
  • discussion - anything that you would like to bring in

All supported labels are listed here.


☕️ Thank you again for finding time for Enform!