Contributing guide

We welcome contributions to the supplementary style guide project. You can either open an issue for discussion, or submit an update using the steps below.

Submitting an update

These instructions show how to submit an update using the command line. You may also use the GitHub web interface for the update. Whichever method you choose, the update should be submitted as a pull request.

Before you begin:

You must have a GitHub account.
You must have set up an SSH key for your GitHub account.

The first time you contribute:

Fork the repository.

From the main page of the GitHub repository, click Fork in the upper right corner.
Clone the forked repository locally.
```
$ git clone git@github.com:<username>/supplementary-style-guide.git
```
If this command fails, be sure that you have set up an SSH key for GitHub.
Navigate to the supplementary-style-guide directory.

Set the upstream remote repository.

$ git remote add -f upstream git@github.com:redhat-documentation/supplementary-style-guide.git

To submit an update:

Fetch the latest changes.
```
$ git fetch upstream
```

Check out a branch from upstream/main

$ git checkout -b <new-branch> upstream/main

Make your edits.

Add or edit files as needed. Be sure to follow the contributing guidelines for this project.
Stage the changes for each file.
```
$ git add <file-name>
```

Commit the changes.

$ git commit -m "<descriptive-commit-message>"

Push the changes to your forked repository.
```
$ git push origin HEAD
```
Open a pull request.

Typically the previous command gives the URL to open a pull request. If not, you can open one from the Pull requests tab of the GitHub UI.

After you submit a pull request, it will be reviewed by members of this project.

Building the guide

You must have asciidoctor installed.

Navigate to the supplementary_style_guide directory.
Use the following command to build the guide:
```
$ asciidoctor main.adoc
```

This generates a main.html file that you can now view in a browser.