Skip to content

Commit

Permalink
Newly generated stuff. Much better.
Browse files Browse the repository at this point in the history
  • Loading branch information
robertdebock committed Dec 8, 2019
1 parent 33abb6b commit 0c25627
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 16 deletions.
64 changes: 64 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,67 @@ You can really make a difference by:
I'll try to help and take every contribution seriously.

It's a great opportunity for me to learn how you use the role and also an opportunity to get into the habit of contributing to open source software.

## Step by step

Here is how you can help, a lot of steps are related to GitHub, not specifically my roles.

### 1. Make an issue.

When you spot an issue, [create an issue](https://github.com/robertdebock/httpd/issues).

Making the issue help me and others to find similar problems in the future.

### 2. Fork the project.

On the top right side of [the repository on GitHub](https://github.com/robertdebock/httpd), click `fork`. This copies everything to your GitHub namespace.

### 3. Make the changes

In you own GitHub namespace, make the required changes.

I typically do that by cloning the repository (in your namespace) locally:

```
git clone [email protected]:YOURNAMESPACE/httpd.git
```

Now you can start to edit on your laptop.

### 4. Optionally: test your changes

Install [molecule](https://molecule.readthedocs.io/en/stable/) and [Tox](https://tox.readthedocs.io/):

```
pip install molecule tox
```

And run `molecule test`. If you want to test a specific distribution, set `image` and optionally `tag`:

```
image=centos tag=7 molecule test
```

Once it start to work, you can test multiple version of Ansible:

```
image=centos tag=7 tox
```

### 6. Optionally: Regenerate all dynamic content

You can use [Ansible Generator](https://github.com/robertdebock/ansible-generator) to regenerate all dynamic content.

If you don't do it, I'll do it later for you.

### 7. Make a pull request

[GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) on pull requests.

In the comment-box, you can [refer to the issue number](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) by using #123, where 123 is the issue number.

### 8. Wait

Now I'll get a message that you've added some code. Thank you, really.

CI starts to test your changes. You can follow the progress on Travis.
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,22 +110,20 @@ Compatibility

This role has been tested on these [container images](https://hub.docker.com/):

|container|tag|allow_failures|
|---------|---|--------------|
|debian|unstable|yes|
|debian|latest|no|
|centos|7|no|
|centos|latest|no|
|fedora|latest|no|
|fedora|rawhide|yes|
|opensuse|latest|no|
|ubuntu|latest|no|

This role has been tested on these Ansible versions:

- ansible>=2.8, <2.9
- ansible>=2.9
- git+https://github.com/ansible/ansible.git@devel
|container|tags|
|---------|----|
|archlinux|all|
|debian|all|
|el|7, 8|
|fedora|all|
|opensuse|all|
|ubuntu|artful, bionic|

The minimum version of Ansible required is 2.8 but tests have been done to:

- The previous version, on version lower.
- The current version.
- The development version.

Exceptions
----------
Expand Down

0 comments on commit 0c25627

Please sign in to comment.