shithub Public

Watch 1 Fork 0 Star 0

markdown · 973 bytes Raw Blame History

Contributing to shithub

shithub is currently pre-launch and closed to external contributions. Once we cross v1.0.0 and the project's own source migrates to a self-hosted shithub instance, this document will be expanded with the full contribution workflow.

In the meantime, if you find a security issue, please follow SECURITY.md.

Post-launch (planned)

Code style: gofumpt + goimports. Lint via golangci-lint.
Commit messages: terse, imperative, single-line unless the change requires elaboration.
DCO sign-off on each commit (git commit -s).
Tests: every change ships with tests proportional to its scope. Integration tests hit a real Postgres; we do not mock the DB seam.
One change per pull request; small PRs are easier to review.

Development setup

git clone https://github.com/tenseleyFlow/shithub.git
cd shithub
make dev

The full development guide will land in docs/internal/contributing.md post-launch.

View source

  
        1
        # Contributing to shithub
      
        2
        
        3
        shithub is currently **pre-launch and closed to external contributions**. Once we cross v1.0.0 and the project's own source migrates to a self-hosted shithub instance, this document will be expanded with the full contribution workflow.
      
        4
        
        5
        In the meantime, if you find a security issue, please follow [SECURITY.md](SECURITY.md).
      
        6
        
        7
        ## Post-launch (planned)
      
        8
        
        9
        - Code style: `gofumpt` + `goimports`. Lint via `golangci-lint`.
      
        10
        - Commit messages: terse, imperative, single-line unless the change requires elaboration.
      
        11
        - DCO sign-off on each commit (`git commit -s`).
      
        12
        - Tests: every change ships with tests proportional to its scope. Integration tests hit a real Postgres; we do not mock the DB seam.
      
        13
        - One change per pull request; small PRs are easier to review.
      
        14
        
        15
        ## Development setup
      
        16
        
        17
        ```sh
      
        18
        git clone https://github.com/tenseleyFlow/shithub.git
      
        19
        cd shithub
      
        20
        make dev
      
        21
        ```
      
        22
        
        23
        The full development guide will land in `docs/internal/contributing.md` post-launch.

1	# Contributing to shithub
2
3	shithub is currently pre-launch and closed to external contributions. Once we cross v1.0.0 and the project's own source migrates to a self-hosted shithub instance, this document will be expanded with the full contribution workflow.
4
5	In the meantime, if you find a security issue, please follow [SECURITY.md](SECURITY.md).
6
7	## Post-launch (planned)
8
9	- Code style: `gofumpt` + `goimports`. Lint via `golangci-lint`.
10	- Commit messages: terse, imperative, single-line unless the change requires elaboration.
11	- DCO sign-off on each commit (`git commit -s`).
12	- Tests: every change ships with tests proportional to its scope. Integration tests hit a real Postgres; we do not mock the DB seam.
13	- One change per pull request; small PRs are easier to review.
14
15	## Development setup
16
17	```sh
18	git clone https://github.com/tenseleyFlow/shithub.git
19	cd shithub
20	make dev
21	```
22
23	The full development guide will land in `docs/internal/contributing.md` post-launch.