Skip to content

Commit d70f09c

Browse files
author
Patrick Thomson
committed
Add OSS-compliance files/documentation.
This is part of https://github.com/github/open-source-releases/issues/470.
1 parent cf92c5f commit d70f09c

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @github/blackbird

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/twirp-rs/fork
4+
[pr]: https://github.com/github/twirp-rs/compare
5+
[code-of-conduct]: CODE_OF_CONDUCT.md
6+
7+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
8+
9+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
10+
11+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
12+
13+
## Prerequisites for running and testing code
14+
15+
We recommend that you install Rust with the `rustup` tool. `twirp-rs` targets stable Rust versions.
16+
17+
## Submitting a pull request
18+
19+
1. [Fork][fork] and clone the repository.
20+
1. Install `protoc` with your package manager of choice.
21+
1. Build the software: `cargo build`.
22+
1. Create a new branch: `git checkout -b my-branch-name`.
23+
1. Make your change, add tests, and make sure the tests and linter still pass.
24+
1. Push to your fork and [submit a pull request][pr].
25+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
26+
27+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
28+
29+
- Write tests.
30+
- 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.
31+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
32+
33+
## Resources
34+
35+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
36+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
37+
- [GitHub Help](https://help.github.com)

SUPPORT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
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.
6+
7+
For help or questions about using this project, please feel free to open an issue or start a discussion.
8+
9+
`twirp-rs` is under active development and maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.
10+
11+
## GitHub Support Policy
12+
13+
Support for this project is limited to the resources listed above.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy