Code contribution acceptance criteria

How to contribute

Fork our repository and submit a pull request when you feel ready to have a review with us. To be considered the Travis build has to be green and all our automation tests have to run without regressions.

Create a new component

If you want to add a new component to our repository make sure you start from our generator:

https://github.com/Alfresco/generator-ng2-alfresco-component

This will make sure we use the same hierarchy, tools, versions, code style and naming conventions. To know more about how it works please refer to the documentation inside the project.

Contribute to the existing code base

What are we reviewing for?

• License: Every file should contain the Alfresco LICENSE header, Apache 2.0 License;
• Tests: Add test cases to cover the new behaviour, and make sure all the existing tests are still green.
• JS Documentation: Every class needs to have its own inline jsdoc, this documentation should explain the general purpose of the class and of each method.
• Documentation: Update the documentation explaining how to use the new functionality, may not be necessary in the cases where change impacts only the CSS style.
• Clean Coding: Some good rules are enforced by the tslint, but we want also our code to be easy to read. Please avoid comments inside the code or leaving pieces of code commented out.
• Responsiveness: Our components support a basic responsiveness, make sure you don't break it and your features support it.
• Localization: Your contribution needs to support localization, all our translation are inside the i18n. The minimum requirement is English.
• Demo: Each component has its own demo, please update it accordingly with your changes.

How long will it take for my contribution to be reviewed?

The time necessary for a code review will vary, smaller changes may be reviewed within days, while larger changes may take more.