Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 4.63 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 4.63 KB
Raw

Contributing

Watch the videos

I've recorded several screencasts to demonstrate how to contribute. Here's a playlist of them all. You'll find individual links by the respective sections

Questions/Help

Watch video

An example will get you help faster than anything else you do. Create an example by going to help.angular-formly.com

Please post questions to StackOverflow using the angular-formly tag. There's also the mailing list where you can ask/answer questions. Also join us on gitter.

If you file an issue with a question, it will be closed. I'm not trying to be mean. I'm just trying to stay sane. :-)

Reporting Bugs / Requesting Features

Watch video

If you've found an issue, please submit it in the issues with a link to a jsbin that demonstrates the issue with issue.angular-formly.com

Pull Requests

Watch video

If you would like to add functionality, please submit an issue first to make sure it's a direction we want to take.

Please do the following:

  • Follow the existing styles (we have an .editorconfig file)
  • Document your changes in the README (try to follow the convention you see in the rest of the file)
  • Create an example for the website that demonstrates your changes so people can see how your changes work

Development

  1. run npm install
  2. run npm start (if you're on a windows machine, see this issue)
  3. write tests & code in ES6 goodness :-)
  4. commit your changes to the src/ directory only please. Also, please keep PRs changing only what the specific issue is addressing. In your commit message, add a reference to the issue it's addressing (i.e. Fixes issue with templateManipulators #153)
  5. notice that there's a pre-commit hook that runs to ensure tests pass and coverage doesn't drop to prevent the build from breaking :-)
  6. push your changes
  7. create a PR with a link to the original issue
  8. wait patiently :-)

Notes

  • Please don't commit any changes to the dist/ directory. This is only committed for releases.
  • Due to some inconsistencies with angular versions, always use require('angular-fix') rather than simply require('angular')
  • If you wish to view your changes visually, you can play around with it in the local-examples directory. Don't commit anything in this directory, but it's a good sanity check. It's just straight JavaScript with an index.html. I recommend http-server.

What do you need help with?

Helping others!

There are a lot of questions from people as they get started using angular-formly. If you could please do the following things, that would really help:

Contributing to community

Contributing to the core

  • Tests are always helpful! Watch video
  • Any of the issues in GitHub, let us know if you have some time to fix one. Especially those labeled PR Please!