Richard T Bonhomme 95af4f0a30

Signed-off-by: Richard T Bonhomme <tincantech@protonmail.com>

2022-10-12 23:47:11 +01:00

Easy-RSA 3 Github Contributions Documentation

This document explains how to contribute to Easy-RSA 3.

Please follow these simple steps and make contributing easier.

Intended audience: Everyone.

Contributing Guide

Do not edit Easy-RSA master branch.
Do not edit Easy-RSA master branch.

Pull Requests submitted from master branch may be be squashed or rejected.

Select a suitable name for the new branch. eg: doc-contrib-typo
```
git checkout -b doc-contrib-typo
```
Make changes to the new branch.

Please use tabs to indent the code but only use tabs at the beginning of the line.
Review the changes:
```
git diff
```
Stage the changes:
```
git add -A
```
Show the extent of the changes:
```
git status -v
```
Commit the changes:
```
git commit -sS
```
Please write a detailed commit message.

github help has details of creating a private key.

Using github no-reply email address is suitable for the Signed-off-by: line.
Push the changes:
```
git push origin doc-contrib-typo
```
Share the changes:
```
Raise a Pull Request on github.
```

Configure the upstream remote for your fork:

git remote add upstream https://github.com/OpenVPN/easy-rsa.git

Verify the remote sources:

git remote -v

Remote origin will have your repository:

origin https://github.com/TinCanTech/easy-rsa.git (fetch)
origin https://github.com/TinCanTech/easy-rsa.git (push)

Remote upstream will be Openvpn/easy-rsa:

upstream https://github.com/Openvpn/easy-rsa.git (fetch)
upstream https://github.com/Openvpn/easy-rsa.git (push)