Skip to content

Commit

Permalink
Update project documentation
Browse files Browse the repository at this point in the history
- CHANGELOG: add installation instructions.
- CONTRIBUTING: add format and changelog instructions.
  • Loading branch information
ale-axelor committed Oct 12, 2020
1 parent 2343476 commit 5e36b8b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,19 @@ Please make sure you don’t post any sensitive information while reporting issu

* [Fork](https://help.github.com/articles/fork-a-repo/) the repo.
* Code!
* Format the java code to follow Google Code Format. Tools:
* Gradle Task: `./gradlew spotlessApply`
* IDE plugin
* [Eclipse](https://github.com/google/google-java-format#eclipse)
* [IntelliJ](https://github.com/google/google-java-format#intellij)
* You must create a changelog entry to describe the change.
See [the README in changelogs folder](https://github.com/axelor/axelor-open-suite/blob/master/changelogs/README.md)
and follow the instructions.
* Push your changes to the topic branch in your fork of the repository.
* Initiate a [pull request](http://help.github.com/send-pull-requests/)
* Update the issue, adding a comment including a link to the created pull request

* Initiate a [pull request](http://help.github.com/send-pull-requests/) on the development branch
that has the issue. For example, if the issue appears in `master` branch then choose `dev` branch,
if the issue appears in `5.3` branch choose `5.3-dev`, etc...

## Code of Conduct

Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,13 @@ Axelor Open Suite includes the following modules :

Axelor Open Suite is built on top of [Axelor Open Platform](https://github.com/axelor/axelor-open-platform)

Download
-------------------------

Installation
================================

To compile and run from source, you will need to clone Axelor Open Suite modules, which is a
[git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) repository, using following commands:

```bash
$ git clone git@github.com:axelor/open-suite-webapp.git
$ cd open-suite-webapp
Expand All @@ -27,3 +32,5 @@ $ git submodule update
$ git submodule foreach git checkout master
$ git submodule foreach git pull origin master
```

You can find more detailed [installation instructions](https://docs.axelor.com/abs/5.0/install/index.html) on our documentation.

0 comments on commit 5e36b8b

Please sign in to comment.