Skip to content

Commit

Permalink
Minor adjustments to readme and hacking
Browse files Browse the repository at this point in the history
  • Loading branch information
reaperzn committed Mar 10, 2018
1 parent e1597a2 commit 5abf901
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
11 changes: 10 additions & 1 deletion HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,20 @@ Where relevant, these are some guidelines:
4) Test the all parts of the application that call the function that has been changed.



**Documentation**

When making any changes to code, make sure documentation (--help, man page) has been updated to reflect any changes

**Merge Rules**

- All pull requests MUST be reviewed and approved before merging
- Pull request Reviews and merges MUST be done by another maintainer
- If possible squash and merge commits
- All travis-ci tests should pass before merging
- If the spellcheck test fails, adding the problematic words to the dictionary is a valid option
- If the shellcheck test fails, you should fix the issues mentioned or adjust the test with explicit comments for the check code and why it is being ignored
- The adjustments to the test files may need to be merged before the PR will pass the tests. This should be done as a separate PR referencing the associated PR for the changes.

**Release Process**

1. Ensure that all files are updated to the version of the release number you're about to tag. This includes:
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
Automatic updates for RHEL, CentOS, Fedora, Ubuntu and Debian Linux servers, with the ability to run pre/post hooks, pre-download packages and reboot after the updates.

**Note about contributions**
Auter is an open source project and we welcome users to send in feature requests and report any bugs in our issues page. We also welcome any help with maintaining the

Auter is an open source project and we welcome users to send in feature requests and report any bugs in our issues page. We also welcome any help with maintaining the application and any code contributions.

**What does auter mean?**
Automatic Update Transaction Execution by Rackspace.
Expand Down

0 comments on commit 5abf901

Please sign in to comment.