inteligr8/acs-community-packaging
1
0
Fork 0
mirror of https://github.com/Alfresco/acs-community-packaging.git synced 2025-05-12 17:05:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

REPO-2756 Add readme and contributing guide

Browse Source
This commit is contained in:
Alex Mukha 2017-08-17 13:32:44 +01:00
parent a0ee0e779e
commit f3038072aa
2 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,16 @@
### Contributing
Thanks for your interest in contributing to this project!
The following is a set of guidelines for contributing to this library. Most of them will make the life of the reviewer easier and therefore decrease the time required for the patch be included in the next version.
Because this project forms a part of Alfresco Content Services, the guidelines are hosted in the [Alfresco Social Community](http://community.alfresco.com/community/ecm) where they can be referenced from multiple projects.
Read an [overview on how this project is goverened](https://community.alfresco.com/docs/DOC-6385-project-overview-repository).
You can report an issue in the ALF project of the [Alfresco issue tracker](http://issues.alfresco.com).
Read [instructions for a good issue report](https://community.alfresco.com/docs/DOC-6263-reporting-an-issue).
Read [instructions for making a contribution](https://community.alfresco.com/docs/DOC-6269-submitting-contributions).
Please follow [the coding standards](https://community.alfresco.com/docs/DOC-4658-coding-standards).

35
README.md Normal file
View File

@ -0,0 +1,35 @@
### Alfresco Community Distribution
This project is producing packaging for [Alfresco Content Services Repository](https://community.alfresco.com/docs/DOC-6385-project-overview-repository).
The artifacts created are:
* A _war_ file
* A distribution zip archive containing the _war_ file and configuration required for deployment to a Web Server.
* SDK dependencies pom file, used by [Alfresco SDK](https://github.com/Alfresco/alfresco-sdk).
### Building
The project can be built by running Maven command:
~~~
mvn clean install
~~~
### Artifacts
The artifacts can be obtained by:
* downloading from [Alfresco repository](https://artifacts.alfresco.com/nexus/content/groups/public)
* getting as Maven dependency by adding the dependency to your pom file (depending on the artifact required):
~~~
<dependency>
<groupId>org.alfresco</groupId>
<artifactId>artefactId</artifactId>
<version>version</version>
</dependency>
~~~
and Alfresco Maven repository:
~~~
<repository>
<id>alfresco-maven-repo</id>
<url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
</repository>
~~~
The SNAPSHOT version of the artifacts is **never** published.
### Contributing guide
Please use [this guide](CONTRIBUTING.md) to make a contribution to the project.