From 59b8ae2ab28cd31dfc679a74d37f5904e060c3f1 Mon Sep 17 00:00:00 2001 From: Mihir Soni Date: Mon, 22 Mar 2021 09:20:13 -0700 Subject: [PATCH] Updates README & CONTRIBUTING.md file (#212) Signed-off-by: Mihir Soni --- CONTRIBUTING.md | 2 +- README.md | 17 +++++++++-------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66bd4ed48f21..35e6e9df7a67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,7 +83,7 @@ We require that every contribution to OpenSearch is signed with a Developer Cert Each commit must include a DCO which looks like this ``` -`Signed``-``off``-``by``:`` ``Richie`` ``Cunningham`` ``` +Signed-off-by: Richie Cunningham ``` You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message. diff --git a/README.md b/README.md index 5a4d0527c110..49a6f612469a 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,15 @@ We officially began work on the new fork on January 21st, 2021. Since then, we'v ## Guiding Principles -* Great software. If it doesn’t solve a user's problem, everything else is moot. It shall be software you love to use. -* Open source like we mean it. Contributors shall be invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy. -* A level playing field. Contributors shall not tweak the software so that it runs better for any vendor at the expense of others. If this happens, call it out and the contributors shall fix it together as a community. -* Used everywhere. The project goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise the community! -* Made with community input. Project maintainers shall ask for public input on direction, requirements, and implementation for any feature built. -* Open to all contributions. Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - the project maintainers shall find a way to make it happen. -* Respectful, approachable, and friendly. This will be a community where all will be heard, accepted, and valued, whether a new or experienced user or contributor. -* A place to invent and innovate. You will be able to innovate rapidly. This project shall have a stable and predictable foundation that is modular, making it easy to extend. + +* **Great software.** If it doesn’t solve your problems, everything else is moot. It’s going to be software you love to use. +* **Open source like we mean it.** We are invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy. +* **A level playing field.** We will not tweak the software so that it runs better for any vendor (including AWS) at the expense of others. If this happens, call it out and we will fix it as a community. +* **Used everywhere.** Our goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise us! +* **Made with your input.** We will ask for public input on direction, requirements, and implementation for any feature we build. +* **Open to contributions.** Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - we will find a way to make that happen. We don’t know what that looks like yet, and we look forward to figuring it out together. +* **Respectful, approachable, and friendly.** This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor. +* **A place to invent.** You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend. ## How you can help