-
Notifications
You must be signed in to change notification settings - Fork 129
Contributing
Andrew Crosby edited this page Jan 18, 2022
·
12 revisions
To contribute to the galaxy_ng
project, we ask that you follow these steps:
- Clone the GitHub repo
- Make a change
- Make sure all tests pass
- Add a a change log file to the
CHANGES
directory. - Commit changes to your
galaxy_ng
clone - Make a pull request from your clone against the master branch
This project follows PEP8 style guide.
The maximum line length for python source code is 100 characters.
-
Each commit message must include at least one reference to an Automation Hub Jira project issue, using the following format:
{Label}: AAH-{number}
The following labels are allowed:
Closes-Bug
Closes-Issue
Partial-Bug
Partial-Issue
Implements
Partial-Implements
Issue
Partial-Issue
Related
Related-Bug
Related-Issue
In rare cases when a commit does not reference an issue, you may put
No-Issue
in the commit message. -
Commit that references one or multiple issues must have a change log record for each issue number referenced in the commit message:
CHANGES/{issue}.{suffix}
A change log record is required for any label present in the commit message, except
Related
,Related-Bug
,Related-Issue
.
- In
galaxy_ng
contributions for bugfixes and features should be made to our default branchmaster
- On-prem releases will come from a
stable/x.y
branch and use tag formatx.y.z
, examples:4.2.0
4.2.1
4.3.0
- Cloud releases will come from the
master
branch and use tag formatcloud-YYYY-MM-DD
- The Red Hat CI environment deploys from
master
- Temporary:
- Red Hat QA, Stage, and Prod environments deploy from
stable
- Red Hat QA, Stage, and Prod environments deploy from
- In
ansible-hub-ui
theprod-stable
branch is used for cloud releases. -
qa-beta
andci-beta
deploy frommaster
-
qa-stable
andci-stable
deploy frommaster-stable
- Future:
- Same as
galaxy_ng
- Same as
Sponsored by Red Hat, Inc.