inteligr8/alfresco-content-app
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-content-app.git synced 2025-05-12 17:04:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-content-app/docs/README.md
Suzana Dirla 8ca13478d5 update the ADF version and the port (#326)
2018-04-20 09:23:08 +01:00

2.7 KiB
Raw Blame History

Alfresco Example Content Application

Introduction

The Alfresco Content Application is an example application built using Alfresco Application Development Framework (ADF) components.

Who is this example application for

This example application demonstrates to Angular software engineers how to construct a content application using the Alfresco ADF.

This example application represents a meaningful composition of ADF components that provide end users with a simple and easy to use interface for working with files stored in the Alfresco Content Services repository.

Prerequisites

This application uses the latest releases from Alfresco:

You also need node.js (8.9.1 or later) installed to build it locally from source code.

The latest version of the Alfresco Content platform is required due to the application using the latest REST APIs developments.

Contribution Policy

How to contribute

Fork our repository and submit a pull request when your code is ready for review. To be considered the Travis build must be green and all our automation tests must run without regressions.

Contribute to the existing code base

What are we reviewing for?

  • License: Every file should contain the Alfresco LICENSE header, LGPL Licence.
  • Tests: Add unit cases to cover the new behavior, 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.
  • Localization: Your contribution needs to support localization, with all new strings externalized, all translations are inside the i18n. The minimum requirement is English.

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 longer.