github/paralus
1
0
Fork 0
mirror of https://github.com/paralus/paralus.git synced 2026-05-13 03:47:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #30 from paralus/update-contribution

Browse Source 
Updated contribution document
This commit is contained in:
Abin Simon
2022-07-01 13:20:22 +05:30
committed by GitHub
parent b3e1f40420 e659a00790
commit a292081a54
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@@ -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,16 @@ 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 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?
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.