|
| 1 | +# Contributing to CodeGate <!-- omit from toc --> |
1 | 2 |
|
2 | | -# Contributing to codegate |
3 | | -First off, thank you for taking the time to contribute to codegate! :+1: :tada: codegate is released under the Apache 2.0 license. If you would like to contribute something or want to hack on the code, this document should help you get started. You can find some hints for starting development in codegate's [README](https://github.com/stacklok/codegate/blob/main/README.md). |
| 3 | +First off, thank you for taking the time to contribute to CodeGate! :+1: :tada: |
| 4 | +CodeGate is released under the Apache 2.0 license. If you would like to |
| 5 | +contribute something or want to hack on the code, this document should help you |
| 6 | +get started. You can find some hints for starting development in CodeGate's |
| 7 | +[README](https://github.com/stacklok/codegate/blob/main/README.md). |
4 | 8 |
|
5 | | -## Table of contents |
6 | | -- [Code of Conduct](#code-of-conduct) |
7 | | -- [Reporting Security Vulnerabilities](#reporting-security-vulnerabilities) |
8 | | -- [How to Contribute](#how-to-contribute) |
| 9 | +## Table of contents <!-- omit from toc --> |
| 10 | + |
| 11 | +- [Code of conduct](#code-of-conduct) |
| 12 | +- [Reporting security vulnerabilities](#reporting-security-vulnerabilities) |
| 13 | +- [How to contribute](#how-to-contribute) |
9 | 14 | - [Using GitHub Issues](#using-github-issues) |
10 | | - - [Not sure how to start contributing...](#not-sure-how-to-start-contributing) |
11 | | - - [Pull Request Process](#pull-request-process) |
| 15 | + - [Not sure how to start contributing?](#not-sure-how-to-start-contributing) |
| 16 | + - [Pull request process](#pull-request-process) |
12 | 17 | - [Contributing to docs](#contributing-to-docs) |
13 | | - - [Commit Message Guidelines](#commit-message-guidelines) |
| 18 | + - [Commit message guidelines](#commit-message-guidelines) |
| 19 | + |
| 20 | +## Code of conduct |
14 | 21 |
|
15 | | -## Code of Conduct |
16 | | -This project adheres to the [Contributor Covenant](https://github.com/stacklok/codegate/blob/main/CODE_OF_CONDUCT.md) code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to code-of-conduct@stacklok.dev. |
| 22 | +This project adheres to the |
| 23 | +[Contributor Covenant](https://github.com/stacklok/codegate/blob/main/CODE_OF_CONDUCT.md) |
| 24 | +code of conduct. By participating, you are expected to uphold this code. Please |
| 25 | +report unacceptable behavior to |
| 26 | +[code-of-conduct@stacklok.dev](mailto:code-of-conduct@stacklok.dev). |
17 | 27 |
|
18 | | -## Reporting Security Vulnerabilities |
| 28 | +## Reporting security vulnerabilities |
19 | 29 |
|
20 | | -If you think you have found a security vulnerability in codegate please DO NOT disclose it publicly until we’ve had a chance to fix it. Please don’t report security vulnerabilities using GitHub issues; instead, please follow this [process](https://github.com/stacklok/codegate/blob/main/SECURITY.md) |
| 30 | +If you think you have found a security vulnerability in CodeGate please DO NOT |
| 31 | +disclose it publicly until we've had a chance to fix it. Please don't report |
| 32 | +security vulnerabilities using GitHub issues; instead, please follow this |
| 33 | +[process](https://github.com/stacklok/codegate/blob/main/SECURITY.md) |
21 | 34 |
|
22 | | -## How to Contribute |
| 35 | +## How to contribute |
23 | 36 |
|
24 | 37 | ### Using GitHub Issues |
25 | | -We use GitHub issues to track bugs and enhancements. If you have a general usage question, please ask in [CodeGate's discussion forum](https://discord.com/invite/RkzVuTp3WK). |
26 | 38 |
|
27 | | -If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project that reproduces the problem. |
| 39 | +We use GitHub issues to track bugs and enhancements. If you have a general usage |
| 40 | +question, please ask in |
| 41 | +[CodeGate's discussion forum](https://discord.gg/stacklok). |
| 42 | + |
| 43 | +If you are reporting a bug, please help to speed up problem diagnosis by |
| 44 | +providing as much information as possible. Ideally, that would include a small |
| 45 | +sample project that reproduces the problem. |
| 46 | + |
| 47 | +### Not sure how to start contributing? |
28 | 48 |
|
29 | | -### Not sure how to start contributing... |
30 | | -PRs to resolve existing issues are greatly appreciated and issues labeled as ["good first issue"](https://github.com/stacklok/codegate/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) are a great place to start! |
| 49 | +PRs to resolve existing issues are greatly appreciated and issues labeled as |
| 50 | +["good first issue"](https://github.com/stacklok/codegate/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) |
| 51 | +are a great place to start! |
31 | 52 |
|
32 | | -### Pull Request Process |
33 | | -* Create an issue outlining the fix or feature. |
34 | | -* Fork the codegate repository to your own GitHub account and clone it locally. |
35 | | -* Hack on your changes. |
36 | | -* Correctly format your commit messages, see [Commit Message Guidelines](#Commit-Message-Guidelines) below. |
37 | | -* Open a PR by ensuring the title and its description reflect the content of the PR. |
38 | | -* Ensure that CI passes, if it fails, fix the failures. |
39 | | -* Every pull request requires a review from the core CodeGate team before merging. |
40 | | -* Once approved, all of your commits will be squashed into a single commit with your PR title. |
| 53 | +### Pull request process |
| 54 | + |
| 55 | +- Create an issue outlining the fix or feature. |
| 56 | +- Fork the CodeGate repository to your own GitHub account and clone it locally. |
| 57 | +- Hack on your changes. |
| 58 | +- Correctly format your commit messages, see |
| 59 | + [Commit message guidelines](#commit-message-guidelines) below. |
| 60 | +- Open a PR by ensuring the title and its description reflect the content of the |
| 61 | + PR. |
| 62 | +- Ensure that CI passes, if it fails, fix the failures. |
| 63 | +- Every pull request requires a review from the core CodeGate team before |
| 64 | + merging. |
| 65 | +- Once approved, all of your commits will be squashed into a single commit with |
| 66 | + your PR title. |
41 | 67 |
|
42 | 68 | ### Contributing to docs |
43 | | -Follow [this guide](https://github.com/stacklok/codegate/blob/main/docs/README.md) for instructions on building, running, and previewing codegate's documentation. |
44 | 69 |
|
45 | | -### Commit Message Guidelines |
46 | | -We follow the commit formatting recommendations found on [Chris Beams' How to Write a Git Commit Message article](https://chris.beams.io/posts/git-commit/): |
| 70 | +Follow |
| 71 | +[this guide](https://github.com/stacklok/codegate-docs/blob/main/README.md) for |
| 72 | +instructions on building, running, and previewing CodeGate's documentation. |
| 73 | + |
| 74 | +### Commit message guidelines |
| 75 | + |
| 76 | +We follow the commit formatting recommendations found on |
| 77 | +[Chris Beams' How to Write a Git Commit Message article](https://chris.beams.io/posts/git-commit/): |
47 | 78 |
|
48 | 79 | 1. Separate subject from body with a blank line |
49 | 80 | 1. Limit the subject line to 50 characters |
|
0 commit comments