From 0e0803abd61bdbaf9c8fbee0fbef55121be66677 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= <74345218+sujaya-sys@users.noreply.github.com> Date: Thu, 14 Dec 2023 10:49:29 +0100 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com> --- README.md | 36 +++++++++++++----------------------- 1 file changed, 13 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8324f7c9..db045b66 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,5 @@ ![Score banner](/images/banner.png) -# ![Score](/images/logo.svg) Score overview - -Score is an open source, platform-agnostic, container-based workload specification. This means you can define your workload once with the _Score Specification_ and then use a _Score Implementation_ CLI to translate it to multiple platforms, such as Helm, Docker Compose or Google Cloud Run. - -## ![Contributing](/images/contributing.svg) Contributing - -- Write a [blog](https://score.dev/blog). -- Provide feedback on our [road map and releases board](https://github.com/orgs/score-spec/projects). -- Contribute. - -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. - -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag `enhancement`. - -1. Fork the Project. -2. Create your Feature Branch. `git checkout -b feature/feature-name` -3. Commit your Changes. `git commit -s -m "Add some AmazingFeature"` -4. Push to the Branch. `git push origin feature/feature-name` -5. Open a Pull Request. - -Read [CONTRIBUTING](CONTRIBUTING.md) for more information. - ## Docs This section covers how to build the documentation site with Hugo. @@ -167,6 +145,18 @@ rm package-lock.json You can find our documentation at [docs.score.dev](https://docs.score.dev/docs/). +### Contribute + +If you have a suggestion to improve our documentation, please fork the repo and create a pull request. You can also open an issue with the tag `enhancement`. + +1. Fork the Project. +2. Create your Feature Branch. `git checkout -b feature/feature-name` +3. Commit your Changes. `git commit -s -m "Add some amazing documentation enhancement"` +4. Push to the Branch. `git push origin feature/feature-name` +5. Open a Pull Request. + +Read [CONTRIBUTING](CONTRIBUTING.md) for more information. + ### Roadmap See [Roadmap](roadmap.md). You can [submit an idea](https://github.com/score-spec/spec/issues/new) anytime. @@ -177,4 +167,4 @@ See [Roadmap](roadmap.md). You can [submit an idea](https://github.com/score-spe ### Code of conduct -[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)