Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.96 KB

contributing.md

File metadata and controls

27 lines (18 loc) · 1.96 KB
Raw

Thank you for contributing to Can-React-Component!

If you need any help setting up a CanJS development environment and fixing Can-React-Component bugs, please reach out to us on Slack (#canjs channel) or email (contact@bitovi.com). We will happily walk you through setting up a the environment, creating a test, and submitting a pull request.

Reporting Bugs

To report a bug, please visit GitHub Issues.

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

Search for previous tickets, if there is one add to that one rather than creating another. You can also post on the Forums or talk to us on Slack (#canjs channel).

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 Can-React-Component repository - cd /path/to/can-react-component
  2. Create a new feature branch - git checkout -b <branch name>
  3. Make some changes
  4. Update tests to accomodate your changes
  5. Run tests and make sure they pass in all browsers
  6. Update documentation if necessary
  7. Push your changes to your remote branch - git push origin <branch name>
  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". The team will be notified about your submission and let you know of any problems or targeted release date.