How to contribute

Setting up git and GitHub

The documentation is maintained separately from the other parts of the HXWD website. Instead of your HXWD account, you will need a GitHub account to contribute to the HXWD Documentation. If you are comfortable working with git and GitHub, you can skip ahead to Contributing to the HXWD Docs. If you’ve created a new GitHub account and want to know what to do next, you can choose one of the following ways to contribute changes:

  • GitHub UI - This is the easiest way to contribute small changes described in Simple changes.
  • GitHub Desktop - A desktop app for managing interaction with GitHub.
  • GitHub CLI - A command-line wrapper for interacting with GitHub.
  • git - You can use git from the command line to interact with GitHub. The examples in this document assume you are using this method. The git cheat sheet and Using Git guide are useful resources for beginners and advanced users.

Simple changes

If you want to make a small change like fixing a typo, the GitHub UI is the easiest way to get started. If you’ve found a typo on the page The results of a full text search, for example, you can propose a fix as follows:

  1. Sign in to GitHub
  2. Navigate to https://github.com/tls-kr/tls-kr.github.io
  3. Find the source file, in this case en/manual/search-results.md
  4. Click the edit (pencil) button

From there, the GitHub UI will walk you through the rest by creating a fork and a branch to commit your changes to. After you have made changes to your branch, open a pull request with your changes to be incorporated.

A pull request represents the work you want to be reviewed, approved, and merged into the main branch of the HXWD repository. See the Creating a pull request for more details on creating and handling pull requests successfully.

If you’re not certain of the changes that you want to make, get in touch with us by reporting the problem here!

[!NOTE] You can click the help improve this article link at the bottom of an HXWD page to jump directly to the page source on GitHub.

Simple changes

If you want to make a small change like fixing a typo, the GitHub UI is the easiest way to get started. If you’ve found a typo on the [JavaScript landing page][], for example, you can propose a fix as follows:

  1. Sign in to GitHub
  2. Navigate to https://github.com/mdn/content
  3. Find the source file, in this case files/en-us/web/javascript/index.md
  4. Click the edit (pencil) button

From there, the GitHub UI will walk you through the rest by creating a fork and a branch to commit your changes to. After you have made changes to your branch, open a pull request with your changes to be incorporated.

A pull request represents the work you want to be reviewed, approved, and merged into the main branch of the HXWD repository. See the Creating a pull request for more details on creating and handling pull requests successfully.

Please help improve this article.