Skip to content

Commit b2890c9

Browse files
authored
Create CONTRIBUTING.md
1 parent 835a5ee commit b2890c9

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

CONTRIBUTING.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributing to mkp <!-- omit from toc -->
2+
3+
First off, thank you for taking the time to contribute to mkp! :+1: :tada:
4+
mkp 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 mkp's
7+
[README](https://github.com/StacklokLabs/mkp/blob/main/README.md).
8+
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)
14+
- [Using GitHub Issues](#using-github-issues)
15+
- [Not sure how to start contributing?](#not-sure-how-to-start-contributing)
16+
- [Pull request process](#pull-request-process)
17+
- [Contributing to docs](#contributing-to-docs)
18+
- [Commit message guidelines](#commit-message-guidelines)
19+
20+
## Code of conduct
21+
22+
This project adheres to the
23+
[Contributor Covenant](https://github.com/StacklokLabs/mkp/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).
27+
28+
## Reporting security vulnerabilities
29+
30+
If you think you have found a security vulnerability in mkp 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/StacklokLabs/mkp/blob/main/SECURITY.md)
34+
35+
## How to contribute
36+
37+
### Using GitHub Issues
38+
39+
We use GitHub issues to track bugs and enhancements. If you have a general usage
40+
question, please ask in
41+
[mkp'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?
48+
49+
PRs to resolve existing issues are greatly appreciated and issues labeled as
50+
["good first issue"](https://github.com/StacklokLabs/mkp/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
51+
are a great place to start!
52+
53+
### Pull request process
54+
-All commits must include a Signed-off-by trailer at the end of each commit message to indicate that the contributor agrees to the Developer Certificate of Origin. For additional details, check out the [DCO instructions][dco.md).
55+
56+
- Create an issue outlining the fix or feature.
57+
- Fork the mkp repository to your own GitHub account and clone it locally.
58+
- Hack on your changes.
59+
- Correctly format your commit messages, see
60+
[Commit message guidelines](#commit-message-guidelines) below.
61+
- Open a PR by ensuring the title and its description reflect the content of the
62+
PR.
63+
- Ensure that CI passes, if it fails, fix the failures.
64+
- Every pull request requires a review from the core mkp team before
65+
merging.
66+
- Once approved, all of your commits will be squashed into a single commit with
67+
your PR title.
68+
69+
### Contributing to docs
70+
71+
TBD
72+
73+
### Commit message guidelines
74+
75+
We follow the commit formatting recommendations found on
76+
[Chris Beams' How to Write a Git Commit Message article](https://chris.beams.io/posts/git-commit/):
77+
78+
1. Separate subject from body with a blank line
79+
1. Limit the subject line to 50 characters
80+
1. Capitalize the subject line
81+
1. Do not end the subject line with a period
82+
1. Use the imperative mood in the subject line
83+
1. Use the body to explain what and why vs. how

0 commit comments

Comments
 (0)