Skip to content

Commit 09ea8ca

Browse files
authored
docs: add standardized CONTRIBUTING.md (#36)
## Summary This PR adds a standardized `CONTRIBUTING.md` file that: - Welcomes new contributors - Links to the [main Flatcar CONTRIBUTING guide](https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md) - Provides a section for repo-specific guidelines This change is part of a batch update across all Flatcar repositories to ensure consistent contribution documentation. Ref: flatcar/Flatcar#1865
2 parents cd1f237 + 86b8d23 commit 09ea8ca

1 file changed

Lines changed: 7 additions & 62 deletions

File tree

CONTRIBUTING.md

Lines changed: 7 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,13 @@
1-
# How to Contribute
1+
Welcome! We're so glad you're here and interested in contributing to Flatcar! 💖
22

3-
CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
4-
GitHub pull requests. This document outlines some of the conventions on
5-
development workflow, commit message formatting, contact points and other
6-
resources to make it easier to get your contribution accepted.
3+
Whether you're fixing a bug, adding a feature, or improving docs — we appreciate you!
74

8-
# Certificate of Origin
5+
For more detailed guidelines (finding issues, community meetings, PR lifecycle, commit message format, and more), check out the [main Flatcar CONTRIBUTING guide](https://github.com/flatcar/Flatcar/blob/main/CONTRIBUTING.md).
96

10-
By contributing to this project you agree to the Developer Certificate of
11-
Origin (DCO). This document was created by the Linux Kernel community and is a
12-
simple statement that you, as a contributor, have the legal right to make the
13-
contribution. See the [DCO](DCO) file for details.
7+
---
148

15-
# Email and Chat
9+
## Repository Specific Guidelines
1610

17-
The project currently uses the general CoreOS email list and IRC channel:
18-
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
19-
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
11+
Any guidelines specific to this repository that are not covered in the main contribution guide will be listed here.
2012

21-
## Getting Started
22-
23-
- Fork the repository on GitHub
24-
- Read the [README](README.md) for build and test instructions
25-
- Play with the project, submit bugs, submit patches!
26-
27-
## Contribution Flow
28-
29-
This is a rough outline of what a contributor's workflow looks like:
30-
31-
- Create a topic branch from where you want to base your work (usually main).
32-
- Make commits of logical units.
33-
- Make sure your commit messages are in the proper format (see below).
34-
- Push your changes to a topic branch in your fork of the repository.
35-
- Make sure the tests pass, and add any new tests as appropriate.
36-
- Submit a pull request to the original repository.
37-
38-
Thanks for your contributions!
39-
40-
### Format of the Commit Message
41-
42-
We follow a rough convention for commit messages that is designed to answer two
43-
questions: what changed and why. The subject line should feature the what and
44-
the body of the commit should describe the why.
45-
46-
```
47-
environment: write new keys in consistent order
48-
49-
Go 1.3 randomizes the ordering of keys when iterating over a map.
50-
Sort the keys to make this ordering consistent.
51-
52-
Fixes #38
53-
```
54-
55-
The format can be described more formally as follows:
56-
57-
```
58-
<subsystem>: <what changed>
59-
<BLANK LINE>
60-
<why this change was made>
61-
<BLANK LINE>
62-
<footer>
63-
```
64-
65-
The first line is the subject and should be no longer than 70 characters, the
66-
second line is always blank, and other lines should be wrapped at 80 characters.
67-
This allows the message to be easier to read on GitHub as well as in various
68-
git tools.
13+
<!-- Add repo-specific guidelines below this line -->

0 commit comments

Comments
 (0)