-
Notifications
You must be signed in to change notification settings - Fork 70
Moved Developers to CONTRIBUTING.md
#543
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,54 @@ propose changes to this document in a pull request. | |
| * Perform a [cursory search](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+repo%3Aprojectatomic%2Fatomicapp) | ||
| to see if a similar issue has already been submitted | ||
|
|
||
| ## Developers | ||
|
|
||
| First of all, fork the [repository](https://github.com/projectatomic/atomicapp) and clone your github repository: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Acknowledged |
||
|
|
||
| ```shell | ||
| $ git clone https://github.com/<your-username>/atomicapp | ||
| ``` | ||
|
|
||
| ### Install this project for development | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't understand this part.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. title |
||
|
|
||
| Goto cloned repo and Simply run following commands | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Acknowledged 👍 |
||
|
|
||
| ```shell | ||
| $ sudo pip install virtualenvwrapper | ||
| $ cd atomicapp | ||
| $ make develop | ||
| ``` | ||
|
|
||
| Goto the Nuleculized app directory and run | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will take care of it. |
||
|
|
||
| ```shell | ||
| $ workon atomicapp | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what is
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| $ sudo atomicapp run . | ||
| ``` | ||
|
|
||
| ### Build | ||
| ``` | ||
| docker build -t [TAG] . | ||
| ``` | ||
|
|
||
| Just a call to Docker to package up the application and tag the resulting image. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ### Install and Run | ||
| ``` | ||
| atomicapp [--dry-run] [-a answers.conf] install|run [--recursive] [--update] [--destination DST_PATH] APP|PATH | ||
| ``` | ||
|
|
||
| Pulls the application and it's dependencies. If the last argument is | ||
| existing path, it looks for `Nulecule` file there instead of pulling anything. | ||
|
|
||
| * `--recursive yes|no` Pull whole dependency tree | ||
| * `--update` Overwrite any existing files | ||
| * `--destination DST_PATH` Unpack the application into given directory instead of current directory | ||
| * `APP` Name of the image containing the application (f.e. `vpavlin/wp-app`) | ||
| * `PATH` Path to a directory with installed (i.e. result of `atomicapp install ...`) app | ||
|
|
||
| Action `run` performs `install` prior its own tasks are executed if `APP` is given. When `run` is selected, providers' code is invoked and containers are deployed. | ||
|
|
||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This entire part is old, please have a look at #535
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Once #535 gets merged maybe those changes would reflect here. |
||
| ## Submitting a Pull Request | ||
| Before you submit your pull request consider the following guidelines: | ||
|
|
||
|
|
@@ -54,6 +102,7 @@ Before you submit your pull request consider the following guidelines: | |
| * Rebase your branch and force push to your GitHub repository (this will update your Pull Request): | ||
|
|
||
| ```shell | ||
| git commit --amend | ||
| git rebase master -i | ||
| git push origin bug/my-fix-branch -f | ||
| ``` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,3 +15,11 @@ syntax-check: | |
|
|
||
| clean: | ||
| python setup.py clean --all | ||
|
|
||
| develop: | ||
| source `which virtualenvwrapper.sh`; \ | ||
| mkvirtualenv atomicapp; \ | ||
| python setup.py develop; \ | ||
| echo "alias atomicapp=~/.virtualenvs/atomicapp/bin/atomicapp" >> ~/.virtualenvs/atomicapp/bin/postactivate; \ | ||
| echo "alias sudo='sudo '" >> ~/.virtualenvs/atomicapp/bin/postactivate; \ | ||
| echo "unalias atomicapp && unalias sudo" >> ~/.virtualenvs/atomicapp/bin/postdeactivate | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cool 👍 |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DevelopmentThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Acknowledged 👍