Skip to content

Commit

Permalink
REPO-2756 Add readme and contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
killerboot committed Aug 17, 2017
1 parent d23d6f7 commit 296abe7
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
### Alfresco Server Root
The ROOT.war application is required to enable Alfresco Office Services (AOS).
The source code contains packaging configuration required to build the _ROOT.war_ file.

### 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:
~~~
<dependency>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-server-root</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 artifact is **never** published.

### Contributing guide
Please use [this guide](CONTRIBUTING.md) to make a contribution to the project.

0 comments on commit 296abe7

Please sign in to comment.