commit | 70f9a532c43392204d72e03fe0ba1a86a60125ea | [log] [tgz] |
---|---|---|
author | M Hickford <mirth.hickford@gmail.com> | Sun Feb 26 20:51:45 2023 +0000 |
committer | Gopher Robot <gobot@golang.org> | Mon Feb 27 07:31:09 2023 +0000 |
tree | 682c2a611320bf8ec53197cdc246aaef1587d2ae | |
parent | cd7ff650d3a87f31c5a33cfc46ac64208e37e4af [diff] |
_content/doc/contribute: clarify that all API changes are significant Text verbatim from https://github.com/golang/proposal/commit/4fe2f9757f17bb5375d474f505076afb7afdbbad Change-Id: I726960bac9f5e4e080bcb0cdadcfe7a58422b15d GitHub-Last-Rev: e13cf8a9fc2c0f925fd01bbe69d5c60f9958b505 GitHub-Pull-Request: golang/website#198 Reviewed-on: https://go-review.googlesource.com/c/website/+/471397 Reviewed-by: Ian Lance Taylor <iant@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Ian Lance Taylor <iant@google.com> Run-TryBot: Matt Hickford <matt.hickford@gmail.com> Reviewed-by: Matthew Hickford <hickford@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com>
This repo holds content and serving programs for the go.dev and golang.org web sites.
Content is in _content/ (go.dev) and tour/ (go.dev/tour). Server code is in cmd/ and internal/.
To run the combined go.dev+golang.org server to preview local content changes, use:
go run ./cmd/golangorg
The supporting programs cmd/admingolangorg and cmd/googlegolangorg are the servers for admin.golang.org and google.golang.org. (They do not use the _content/ directories.)
Each command directory has its own README.md explaining deployment.
This repository uses eslint to format JS and TS files, and stylelint to format CSS files.
See also:
It is encouraged that all JS, TS, and CSS code be run through formatters before submitting a change. However, it is not a strict requirement enforced by CI.
./npm install
./npx eslint [options] [file] [dir]
./npx stylelint [input] [options]
TypeScript files served from _content are transformed into JavaScript. Reference .ts files in html templates as module code.
<script type="module" src="/ts/filename.ts">
Write unit tests for TypeScript code using the jest testing framework.
./npx jest [TestPathPattern]
Each time a CL is reviewed and submitted, the code is deployed to App Engine. See cmd/golangorg/README.md for details.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://go.dev/doc/contribute.
The main issue tracker for the website repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/website:” in the subject line, so it is easy to find.