Skip to content

open source release: add required files #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This repository is maintained by:
* @vdye @derrickstolee @ldennington
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language.
* Being respectful of differing viewpoints and experiences.
* Gracefully accepting constructive criticism.
* Focusing on what is best for the community.
* Showing empathy towards other community members.

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances.
* Trolling, insulting/derogatory comments, and personal or political attacks.
* Public or private harassment.
* Publishing others' private information, such as a physical or electronic
address, without explicit permission.
* Other conduct which could reasonably be considered inappropriate in a
professional setting.

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
52 changes: 52 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## Contributing

[code-of-conduct]: CODE_OF_CONDUCT.md
[commit-guidance]: https://github.blog/2022-06-30-write-better-commits-build-better-projects/
[compare]: https://github.com/github/git-bundle-server/compare
[contributions-under-license]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
[github-help]: https://help.github.com
[license]: LICENSE
[open-source-contributions]: https://opensource.guide/how-to-contribute/
[pr-guidance]: https://help.github.com/articles/about-pull-requests/
[readme]: README.md

Hi there! We're thrilled that you'd like to contribute to the `git-bundle-server`
project. Your work is extremely appreciated :star:.

Contributions to this project are [released][contributions-under-license] to the public
under the [project's open source license][license].

Please note that this project is released with a [Contributor Code of
Conduct][code-of-conduct]. By participating in this project you agree to abide
by its terms.

## Prerequisites for running and testing code

Check out the project's [`README`][README] for thorough guidance on how
to hit the ground running :dash:.

## Submitting a pull request

1. Clone the repository.
0. Reference the project's [`README`][README] to build, test, and lint.
0. Create a new branch: `git checkout -b <my-branch-name>`
0. Do some awesome work :sparkles:.
0. Add tests and make sure the tests and linter still pass.
0. Push your changes and [submit a pull request][compare].
0. Pat yourself on the back and wait for your pull request to be reviewed
and merged.

Here are a few things you can do that will increase the likelihood of your pull
request being accepted:

- Write tests.
- Keep your change as focused as possible. If there are multiple changes you
would like to make that are not dependent upon each other, consider submitting
them as separate pull requests.
- Write a [good commit message][commit-guidance].

## Resources

- [How to Contribute to Open Source][open-source-contributions]
- [Using Pull Requests][pr-guidance]
- [GitHub Help][github-help]
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
# `git-bundle-server`: Manage a self-hosted bundle server

[bundle-uris]: https://github.com/git/git/blob/next/Documentation/technical/bundle-uri.txt
[codeowners]: CODEOWNERS
[contributing]: CONTRIBUTING.md
[license]: LICENSE
[support]: SUPPORT.md

## Background

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

[bundle-uris]: https://github.com/git/git/blob/next/Documentation/technical/bundle-uri.txt
This repository is under active development, and loves contributions from the
community :heart:. Check out [CONTRIBUTING][contributing] for details on getting
started.

## Cloning and Building

Expand All @@ -16,6 +26,14 @@ executables with
$ go build -o . ./...
```

## Testing and Linting

To run the project's unit tests, navigate to the repository root directory and
run `go test -v ./...`.

To run the project's linter, navigate to the repository root directory and run
`go vet ./...`.

## Bundle Management through CLI

The following command-line interface allows you to manage which repositories are
Expand Down Expand Up @@ -66,3 +84,17 @@ server, you can manage the web server process itself using these commands:

Finally, if you want to run the web server process directly in your terminal,
for debugging purposes, then you can run `git-bundle-web-server`.

## License

This project is licensed under the terms of the MIT open source license. Please
refer to [LICENSE][license] for the full terms.

## Maintainers

See [CODEOWNERS][codeowners] for a list of current project maintainers.

## Support

See [SUPPORT][support] for instructions on how to file bugs, feature requests,
and general questions/requests for help.
8 changes: 8 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Security

[bug-bounty]: https://hackerone.com/github?type=team

If you discover a security issue in this repo, please submit it through the
[GitHub Security Bug Bounty program][bug-bounty].

Thanks for helping make open source products on GitHub safe for everyone.
20 changes: 20 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Support

[discussion]: https://github.com/github/git-bundle-server/discussions

## How to file issues and get help

This project uses GitHub issues to track bugs and feature requests. Please search
the existing issues before filing new issues to avoid duplicates. For new
issues, file your bug or feature request as a new issue.

For help or questions about using this project, please start a
[Discussion][discussion].

- `git-bundle-server` is under active development and maintained by GitHub
staff **AND THE COMMUNITY**. We will do our best to respond to support, feature
requests, and community questions in a timely manner.

## GitHub Support Policy

Support for this project is limited to the resources listed above.