From bae482a5e79440570d729c856044b36681ab5297 Mon Sep 17 00:00:00 2001 From: techmaharaj Date: Thu, 30 Jun 2022 15:29:34 +0530 Subject: [PATCH 1/2] Updated contribution document --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 245eee0..d411b10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Yes, because we feel that it’s the best way to build and improve a product. It We are always on the lookout for anything that can improve the product. Be it feature requests, issues/bugs, code or content, we’d love to see what you’ve got to make this better. If you’ve got anything exciting and would love to contribute, this is the right place to begin your journey as a contributor to Paralus and the larger open source community. -**How to get started?** +## How to get started? The easiest way to start is to look at existing issues and see if there’s something there that you’d like to work on. You can filter issues with the label “[Good first issue](https://github.com/paralus/paralus/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)” which are relatively self sufficient issues and great for first time contributors. @@ -12,6 +12,13 @@ Once you decide on an issue, please comment on it so that all of us know that yo If you’re looking to add a new feature, [raise a new issue](https://github.com/paralus/paralus/issues/new) and start a discussion with the community. Engage with the maintainers of the project and work your way through. +You'll need to perform the following tasks in order to submit your changes: + +- Fork the Paralus repository. +- Create a branch for your changes. +- Add commits to that branch. +- Open a PR to share your contribution. + Below are all the details you need to know about the `Paralus` repo and get started with the development. # Paralus @@ -131,6 +138,14 @@ Start Paralus: go run github.com/paralus/paralus ``` +#### Updating Proto Files? + +If you're making changes to any of the proto files, you'll have to perform the following steps: + +- `make clean` - would clean all the *.pb files +- `make build-proto` - would ensure changes to proto are valid +- `make gen-proto` - to generate *.pb files with the latest changes to proto files. + ## Need Help? If you are interested to contribute to core but are stuck with any of the steps, feel free to reach out to us. Please [create an issue](https://github.com/paralus/paralus/issues/new) in this repository describing your issue and we'll take it up from there. From e659a00790c6659636da2255ad8f9050bde14087 Mon Sep 17 00:00:00 2001 From: techmaharaj Date: Fri, 1 Jul 2022 11:36:46 +0530 Subject: [PATCH 2/2] Updated contribution document --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d411b10..ef081c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -142,9 +142,11 @@ go run github.com/paralus/paralus If you're making changes to any of the proto files, you'll have to perform the following steps: -- `make clean` - would clean all the *.pb files -- `make build-proto` - would ensure changes to proto are valid -- `make gen-proto` - to generate *.pb files with the latest changes to proto files. +- `make build` - build binary artifacts. +- `make test` - run all tests. +- `make check` - perform check like fmt and vet. +- `make clean` - clean all binary artifacts. +- `make build-proto` - rebuild all proto files. ## Need Help?