From a03a7ea2292bb41dd678d2b5ed05580248cc5282 Mon Sep 17 00:00:00 2001 From: Balazs Nadasdi Date: Thu, 7 Oct 2021 17:07:13 +0200 Subject: [PATCH] Extend CONTRIBUTING.md --- CONTRIBUTING.md | 32 +++++++++++++++++++++++++++++++- README.md | 9 ++++++++- 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1b89b7f1..31a56b838 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,4 +28,34 @@ The maintainers will add the correct labels/milestones to the issue for you. ### Contributing your code - +The process to contribute code to Reignite is very straight forward. + +1. Go to the project on [GitHub][repo] and click the `Fork` button in the + top-right corner. This will create your own copy of the repository in your + personal account. +2. Using standard `git` workflow, `clone` your fork, make your changes and then + `commit` and `push` them to your repository. +3. Run `make generate`, then `commit` and `push` the changes. +4. Go back to [GitHub][repo], select `Pull requests` from the top bar and click + `New pull request` to the right. Select the `compare across forks` link. + This will show repositories in addition to branches. +5. From the `head repository` dropdown, select your forked repository. If you + made a new branch, select it in the `compare` dropdown. You should always + target `weaveworks/ignite` and `main` as the base repository and branch. +6. With your changes visible, click `Create pull request`. Give it a short, + descriptive title and write a comment describing your changes. Click `Create + pull request`. + +That's it! Maintainers follow pull requests closely and will add the correct +labels and milestones. After a maintainer's review small changes/improvements +could be requested, don't worry, feedback can be easily addressed by performing +the requested changes and doing a commit and push. Your new changes will +automatically be added to the pull request. + +We also have Continuous Integration (CI) set up (powered by [GitHub +Actions][gha]) that will build the code and verify it compiles and passes all +tests successfully. If your changes didn't pass CI, you can click Details to go +and check why it happened. To integrate your changes, we require CI to pass. + +[repo]: https://github.com/weaveworks/reignite +[gha]: https://github.com/weaveworks/reignite/actions diff --git a/README.md b/README.md index 3580f7803..e4be202f4 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,15 @@ ## What is (Re)Ignite? +Reignite is a Kubernetes cluster provisioning and manager service on a bare +metal infrastructure. + ## Use-cases +* Companies that want to use Kubernetes, but they are tied to their physical + servers for technical or legal reasons. +* ??? + ## Documentation * [Getting started with reignite][quickstart] @@ -25,7 +32,7 @@ Other interesting resources include: ## Getting Help -If you have any questions about, feedback for or problems with ignite: +If you have any questions about, feedback for or problems with reignite: * [File an issue][issues].