Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 1.22 KB
Raw

Thank you for contributing to @bigab/use-epic!

Reporting Bugs

To report a bug, please visit GitHub Issues.

When filing a bug, it is helpful to include small examples using tools like CodeSandbox or CodePen.

Search for previous tickets, if there is one add to that one rather than creating another.

Contributing

When contributing, please include tests with new features or bug fixes in a feature branch until you're ready to submit the code for consideration; then push to the fork, and submit a pull request. More detailed steps are as follows:

  1. Navigate to your clone of the @bigab/use-epic repository - cd /path/to/@bigab/use-epic
  2. Create a new feature branch - git checkout -b some-fix
  3. Make some changes
  4. Update tests to accomodate your changes
  5. Run tests (npm test) and make sure they pass
  6. Update the documentation if necessary
  7. Push your changes to your remote branch - git push -u origin some-fix
  8. Submit a pull request! Navigate to Pull Requests and click the 'New Pull Request' button. Fill in some details about your potential patch including a meaningful title. When finished, press "Send pull request".