Skip to content

Commit b4552b9

Browse files
Lessley Denningtonldennington
authored andcommitted
open source release: add CONTRIBUTING.md
A CONTRIBUTING.md file is one of the requirements for releasing projects as open source. Add CONTRIBUTING.md file with instructions on expected workflows accordingly. Signed-off-by: Lessley Dennington <[email protected]>
1 parent f3f37a5 commit b4552b9

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Contributing
2+
3+
[code-of-conduct]: CODE_OF_CONDUCT.md
4+
[commit-guidance]: https://github.blog/2022-06-30-write-better-commits-build-better-projects/
5+
[compare]: https://github.com/github/git-bundle-server/compare
6+
[contributions-under-license]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
7+
[github-help]: https://help.github.com
8+
[license]: LICENSE
9+
[open-source-contributions]: https://opensource.guide/how-to-contribute/
10+
[pr-guidance]: https://help.github.com/articles/about-pull-requests/
11+
[readme]: README.md
12+
13+
Hi there! We're thrilled that you'd like to contribute to the `git-bundle-server`
14+
project. Your work is extremely appreciated :star:.
15+
16+
Contributions to this project are [released][contributions-under-license] to the public
17+
under the [project's open source license][license].
18+
19+
Please note that this project is released with a [Contributor Code of
20+
Conduct][code-of-conduct]. By participating in this project you agree to abide
21+
by its terms.
22+
23+
## Prerequisites for running and testing code
24+
25+
Check out the project's [`README`][README] for thorough guidance on how
26+
to hit the ground running :dash:.
27+
28+
## Submitting a pull request
29+
30+
1. Clone the repository.
31+
0. Reference the project's [`README`][README] to build, test, and lint.
32+
0. Create a new branch: `git checkout -b <my-branch-name>`
33+
0. Do some awesome work :sparkles:.
34+
0. Add tests and make sure the tests and linter still pass.
35+
0. Push your changes and [submit a pull request][compare].
36+
0. Pat yourself on the back and wait for your pull request to be reviewed
37+
and merged.
38+
39+
Here are a few things you can do that will increase the likelihood of your pull
40+
request being accepted:
41+
42+
- Write tests.
43+
- Keep your change as focused as possible. If there are multiple changes you
44+
would like to make that are not dependent upon each other, consider submitting
45+
them as separate pull requests.
46+
- Write a [good commit message][commit-guidance].
47+
48+
## Resources
49+
50+
- [How to Contribute to Open Source][open-source-contributions]
51+
- [Using Pull Requests][pr-guidance]
52+
- [GitHub Help][github-help]

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# `git-bundle-server`: Manage a self-hosted bundle server
22

33
[bundle-uris]: https://github.com/git/git/blob/next/Documentation/technical/bundle-uri.txt
4+
[contributing]: CONTRIBUTING.md
45
[license]: LICENSE
56

67
## Background
78

89
By running this software, you can self-host a bundle server to work with Git's
910
[bundle URI feature][bundle-uris].
1011

12+
This repository is under active development, and loves contributions from the
13+
community :heart:. Check out [CONTRIBUTING][contributing] for details on getting
14+
started.
15+
1116
## Cloning and Building
1217

1318
Be sure to clone inside the `src` directory of your `GOROOT`.
@@ -19,6 +24,14 @@ executables with
1924
$ go build -o . ./...
2025
```
2126

27+
## Testing and Linting
28+
29+
To run the project's unit tests, navigate to the `git-bundle-server` directory
30+
and run `go test -v ./...`.
31+
32+
To run the project's linter, navigate to the `git-bundle-server` directory
33+
and run `go vet ./...`.
34+
2235
## Bundle Management through CLI
2336

2437
The following command-line interface allows you to manage which repositories are

0 commit comments

Comments
 (0)