CONTRIBUTING.md

Welcome to GoSH docs contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Getting started

Staring by having a look at our style guide. Our linter is closely based on the style guide.

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Repository Structure

Our GoSH package is closely mimic our SiteHost public API endpoints, therefore the folder structure under /pkg/api/ should be similar to our endpoints. For example:

• /pkg/api/job represents the job endpoint.
• /pkg/api/server represents the server endpoint.

When adding a new endpoint, please make sure to follow our API structure.

Make changes locally

1. Fork the repository.

   • Using GitHub Desktop:

     • Getting started with GitHub Desktop will guide you through setting up Desktop.
     • Once Desktop is set up, you can use it to fork the repo!

   • Using the command line:

     • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

2. Install or update to Golang v1.19. Or you can use docker image.

3. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The SiteHost team thanks you ✨.