docs: add CONTRIBUTING.md with contribution guidelines#33
Conversation
Signed-off-by: amitabh90 <amitabh90.das@gmail.com>
tormath1
left a comment
tormath1
left a comment
There was a problem hiding this comment.
Thanks for this PR. If you are using some AI tools to generate this PR, please be sure that it makes sense (e.g CoreOS / Flatcar mentions).
This document does not really explain how to contribute to flatcar-terraform specifics (e.g: run OpenTofu / Terraforms tests, how to organize / document providers, etc.)
I'd say that most of this is generic to any open-source contributions and we could think about this:
- a common
CONTRIBUTING.mdshould be in theflatcar/flatcarrepository - if needed a
CONTRIBUTING.mdshould link to this one ⬆️ and add specific bits for the repository in this file (cc @John15321)
It's linked to: flatcar/Flatcar#1816
|
|
||
| The project currently uses the general CoreOS email list and IRC channel: | ||
| - Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev) | ||
| - IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org |
There was a problem hiding this comment.
No IRC channel is officially maintained for Flatcar.
|
|
||
| Welcome! We’re excited that you’re interested in contributing to this project. Whether you’re a seasoned developer or new to open source, your contributions are valued and appreciated. Please read the guidelines below to help us maintain a collaborative and inclusive environment. | ||
|
|
||
| CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via |
There was a problem hiding this comment.
Please update all CoreOS mention to Flatcar
| simple statement that we, as contributors, have the legal right to make the | ||
| contribution. See the [DCO](DCO) file for details. | ||
|
|
||
| # Email and Chat |
There was a problem hiding this comment.
You can actually refer to this: https://github.com/flatcar/flatcar?tab=readme-ov-file#chat
|
@amitabh90 Hey, thanks for looking into this. But as stated in this comment: flatcar/Flatcar#1816 (comment) We need to wait on a few more things to fall in place, given that the whole contributing "experience" is changing right now, there might be a few more that change in a bit, so lets wait till its all settled |
|
@John15321 sure we can wait until flatcar/Flatcar#1816 (comment) |
3 participants
Title: Adds a CONTRIBUTING.md
describing the change
Adds a CONTRIBUTING.md file outlining contribution guidelines and workflow.
Helps new contributors understand the process and expectations for this project.
How to use
[ describe what reviewers need to do in order to validate this PR ]
Testing done
[Describe the testing you have done before submitting this PR. Please include both the commands you issued as well as the output you got.]
changelog/directory (user-facing change, bug fix, security fix, update)/bootand/usrsize, packages, list files for any missing binaries, kernel modules, config files, kernel modules, etc.