How to Submit a GitHub Pull Request (PR) for Akinon Documentation

Find the File You Want to Edit

• Browse through the repository and locate the file that you wish to edit.

• You can either navigate directly to the file through the folder structure or use the search bar at the top of the repository to find it.

Make Your Changes

• Click on the pencil icon (✏️) to edit the file.

• Make the necessary changes or updates to the documentation.

• Once you’ve made your edits, click the Commit changes... button.

Commit the Changes

In the Commit changes section:

• Enter a short, descriptive Commit message for your changes (e.g., "Update product setup instructions").

• Add a more detailed description of your changes in the second box under Extended description.

• Select Create a new branch for this commit and start a pull request.

• Enter a name for your new branch.

• Click on Propose changes to commit the changes to the new branch.

Create a Pull Request (PR)

• After proposing the changes, GitHub will prompt you to create a Pull Request.

• Add a title and description for the PR, explaining what changes you made and why.

• Add reviewers: Make sure to add technical writers (gozdeayber and ilaydaocalan) as reviewers.

• Click on Create pull request to submit the PR.

Review and Merge

Once the technical writers reviews your PR, they will merge it into the main branch.