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
An example will get you help faster than anything else you do. Create an example by going to help.angular-formly.com
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
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
Watch video (slightly out of date)
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
- 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
npm start(if you're on a windows machine, see this issue)
- write tests & code in ES6 goodness :-)
git add src/
npm run commitand follow the prompt (this ensures that your commit message follows our conventions).
- 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 :-)
- push your changes
- create a PR with a link to the original issue
- wait patiently :-)
- 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
- If you wish to view your changes visually, you can play around with it in the
index.html. I recommend
What do you need help with?
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:
- Subscribe to the
angular-formlyquestions RSS Feed on StackOverflow. You can use this free service: Blogtrottr to have it email you with new questions.
- Hang out on the chat
- Sign up on the mailing list
- Watch the angular-formly repositories for issues or requests that you could help with (like angular-formly-website for requests for examples).
Contributing to community
- Create plugins! ideas
- Write blog posts! Like these
- Record screencasts
- Write examples. The website is driven by examples. Watch video