Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

55 lines (28 loc) · 1.69 KB
Raw

Contributing to ngx-loadable

Hello there. Thanks for taking time out to contribute to ngx-loadable!

We are open to any kind of contribution: code, documentation, bug-fixing (even just reports), feature-requests and anything else you may come up with.

Coding

Nothing fancy here, just:

  1. Fork this repo

  2. Run npm install to install the relevant modules

  3. Run npm run build:lib to build the ngx-loadable library

  4. Run npm start to serve the project

  5. Do your magic! ✨

  6. Commit you code

  7. Submit a pull request. It will be reviewed by maintainers and they'll give you proper feedback so you can iterate over it.

Please note: Any contributions you make are understood to be under the same MIT License that covers this project.

Considerations

Documenting

Code should be self-documented. But, in case there is any code that may be hard to understand, it must include some comments to make it easier to review and maintain later on.

Reporting bugs

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Great Bug Reports tend to have:

  • A quick summary and/or background

  • Steps to reproduce

  • Be specific!

  • Give sample code if you can.

  • What you expected would happen

  • What actually happens

  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)