aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
Commit message (Collapse)AuthorAgeFilesLines
* docs/contributing.md: remove deprecated instructions to use ghcrDaniel2025-09-221-13/+0
|
* tools/syz-env: add local build optionStefan Wiehler2024-11-291-0/+6
| | | | Useful for testing local Dockerfile changes that have not been pushed yet.
* all: add npm package to syz-envJoey Jiao2024-08-291-0/+13
| | | | | | | | | | act(https://github.com/nektos/act) is used to build github workflow locally. When running `act -j build` in local host, it reports: exec failed: unable to start container process: exec: "node": executable file not found in $PATH: unknown. Adding nodejs package can fix the build error. Updated docs with act usage too.
* docs/contributing.md: fix a typoQGrain2024-07-151-1/+1
| | | | Fix a typo in the section of "Using syz-env": expacted to expected.
* docs: typo fixesDavidlohr Bueso2023-06-071-3/+3
| | | | Fix various typos within the documentation directory.
* /docs: update instructions for source checkoutAdam Goska2022-01-191-4/+3
| | | | | | Updated documentation regarding source code checkout from the legacy gopath mode 'go get' to 'git clone'. Fixes #2828
* pkg/host, docs: fix typosPatrick Meyer2021-05-061-1/+1
|
* docs: extend contributing.mdDmitry Vyukov2021-04-211-6/+17
| | | | Add some general contribution guidelines.
* docs/contributing.md: fix syz-env invocationGarret Kelly2021-04-191-1/+1
| | | | | | Paths like SOURCEDIR must be absolute as they're being used as volume paths given to Docker and will be interpreted as Docker volume names if not absolute paths.
* tools/docker: mirror images on githubDmitry Vyukov2020-09-121-0/+13
| | | | | Some users don't have access to the gcr.io registry. Mirror images on github as well.
* .github/workflows: check commit description formatDmitry Vyukov2020-07-311-0/+11
| | | | | Check PR commit subjects for the standard format we use "pkg/name: description of the change". Check PR commit bodies for at most 120 characters.
* docs: add instructions on updating syz-envAndrey Konovalov2020-07-151-0/+6
|
* tools: add syz-envDmitry Vyukov2020-05-181-0/+25
| | | | | | | | | | | syz-env provides a canned dev environment with all tools necessary (Go, gcc, clang-format, etc) for development/testing in a form of a Docker image. Example use: $ syz-env make presubmit $ syz-env make extract SOURCEDIR=~/linux Update #1699
* docs/contributing.md: updatesAndrey Konovalov2020-05-111-34/+44
|
* docs: various updates all overAndrey Konovalov2020-05-081-3/+3
|
* docs: move go install instructions to setup.mdAndrey Konovalov2020-05-071-36/+2
| | | | Also update go version requirement to 1.13.
* docs: update source download instructionsDmitry Vyukov2020-05-021-5/+10
| | | | | | | | Since we don't don't have auto-generated files checked-in, go get fails to parse packages. go get only prog package without building, this will checkout the whole repo anyway and that's the only thing we need.
* Makefile: generate descriptions on-the-flyDmitry Vyukov2020-04-301-4/+3
| | | | | | | | | | | | | | | | | | Checking in the generated descriptions files makes few things simpler, but causes pain for pull requests: (1) PRs that touch descriptions _always_ conflict, (2) PRs are large and harder to review, (3) people sometimes forget to add auto-generated files. The proposed way does not require us to hardcode lots of dependencies in the Makefile (which is nice) and seem to work. Let's see how it works. The main contributor-visible consequence is that the auto-generated files do not need to be checked-in now. Credit for figuring the Makefile magic goes to @melver. Fixes #1291
* Update contributing.mdAndrey Konovalov2020-02-251-3/+10
|
* Update contributing.mdAndrey Konovalov2020-02-251-2/+2
|
* Update contributing.mdAndrey Konovalov2020-02-251-9/+11
|
* docs: fix go get instructionsDmitry Vyukov2020-02-171-1/+1
|
* docs: update syscall_descriptions.md and contributing.mdShiyu Sun2019-11-201-0/+1
| | | | Add suggestions for running make install_prerequisites.
* all: switch to Go 1.12Dmitry Vyukov2019-03-141-14/+27
| | | | | | | | Differences in code formatting between Go versions cause constant problems for us (https://github.com/golang/go/issues/25161). Currently we support 1.9 and 1.10. Switch to newer 1.11 and 1.12. Fixes #1013
* docs: extend descriptions/programs docsDmitry Vyukov2019-03-141-4/+12
| | | | | | Extend doc on descriptions, const generation process, add more links to internals, explain programs, etc. Clarify that all generated files are checked in.
* docs: fix step to create local branch from new originVictor Hsieh2018-12-191-1/+1
| | | | | The current step creates a local branch from the default origin, which is probably not my-origin in the instruction.
* docs: update contributing.mdDmitry Vyukov2018-12-031-7/+13
| | | Clarify commit description guidelines.
* Update contributing.mdDmitry Vyukov2018-10-101-4/+8
| | | fix formatting
* [doc] Update contributing instructions.Julia Hansbrough2018-08-171-0/+11
| | | | Details how to run tests and how to work around gofmt bug.
* Update contributing.mdAndrey Konovalov2017-11-071-6/+7
|
* Update contributing.mdDmitry Vyukov2017-11-031-0/+21
|
* Update contributing.mdDmitry Vyukov2017-10-181-1/+10
|
* Update contributing.mdDmitry Vyukov2017-10-181-0/+1
|
* docs: various improvementsAndrey Konovalov2017-06-141-4/+12
|
* docs: move parts of README to docsAndrey Konovalov2017-06-141-1/+13
|
* docs: move contributing section from README to docs/Andrey Konovalov2017-06-141-0/+3