Skip to content
This repository has been archived by the owner on Jan 19, 2018. It is now read-only.

Latest commit

 

History

History
177 lines (122 loc) · 5.6 KB

CONTRIBUTING.md

File metadata and controls

177 lines (122 loc) · 5.6 KB
Raw

Contributing to Atomic App

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines (not rules) for contributing to Atomic App, which is hosted in the Project Atomic Organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Initial dev environment

First of all, clone the github repository: git clone https://github.com/projectatomic/atomicapp..

Installing Atomic App locally

Simply run

make install

If you want to do some changes to the code, I suggest to do:

cd atomicapp
export PYTHONPATH=`pwd`:$PYTHONPATH
alias atomicapp="python `pwd`/atomicapp/cli/main.py"

Building for containerized execution

docker build -t [TAG] .

Use 'docker build' to package up the application and tag the resulting image.

Fetch and run

atomicapp [--dry-run] [-v] [-a answers.conf] fetch|run|stop|genanswers [--provider docker] [--destination DST_PATH] APP|PATH

Pulls the application and its dependencies. If the last argument is existing path, it looks for Nulecule file there instead of pulling anything.

  • --provider docker Use the Docker provider within the Atomic App
  • --destination DST_PATH Unpack the application into given directory instead of current directory
  • APP Name of the image containing the application (ex. projectatomic/apache-centos7-atomicapp)
  • PATH Path to a directory with installed (ex. result of atomicapp fetch...) app

Action run performs fetch prior to its own tasks if an APP is provided. Otherwise, it will use its respective PATH. When run is selected, providers' code is invoked and containers are deployed.

Submitting Issues

  • You can create an issue here, include as many details as possible with your report.
  • Include the version of Atomic App you are using, have a look at the docker container image tag.
  • Include the behavior you expected and maybe other places you've seen that behavior
  • Perform a cursory search to see if a similar issue has already been submitted

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Make your changes in a new git branch:

    git checkout -b bug/my-fix-branch master

  • Create your patch, including appropriate test cases. Do not forget to add a copyright notice to your files, pls read along the line 625 of gpl-3.txt

  • Please test your changes locally for conformance of coding guidelines with following command

    $ tox

  • Include documentation that either describe a change to a behavior of atomicapp or the changed capability to an end user of atomicapp.

  • Commit your changes using a descriptive commit message. If you are fixing an issue please include something like 'this closes issue #xyz'.

  • Make sure your tests pass! As we use travis-ci with flake8 it's recommended to run both commands before submitting a PR.

    make syntax-check
make test

  • Push your branch to GitHub:

    git push origin bug/my-fix-branch

  • In GitHub, send a pull request to atomicapp:master.

  • If we suggest changes then:

    • Make the required updates.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push origin bug/my-fix-branch -f

That's it! Thank you for your contribution!

NOTE: When submitting a documentation PR, you can skip the travis ci by adding [ci skip] to your commit message.

Merge Rules

  • Include unit or integration tests for the capability you have implemented
  • Include documentation for the capability you have implemented
  • If you are fixing an issue within Atomic App,
  • include the issue number you are fixing

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the upstream repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete bug/my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D bug/my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Reference issues and pull requests liberally

How to Test

Functional tests and unit tests are part of this repository. We prepared a Dockerfile which creates an image able to run these tests. To build it, run:

docker build -t atomicapp-test -f Dockerfile.test .

In case you want to test code which is currently in repository, run:

docker run -t --rm atomicapp-test

To test your changes in code you have two options:

  1. rebuild the image every time you save a file
  2. add a volume to the docker run command as follows
docker run -t --rm -v $PWD/atomicapp:/opt/atomicapp/atomicapp atomicapp-test

You can use following command to run tests you added:

docker run -t --rm -v $PWD/tests/:/opt/atomicapp/tests atomicapp-test