Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Our contributing doc update #23

Open
rkooo567 opened this issue Apr 11, 2019 · 1 comment
Open

Our contributing doc update #23

rkooo567 opened this issue Apr 11, 2019 · 1 comment

Comments

@rkooo567
Copy link
Collaborator

For open source programs, clear contribution guide is essential. The current contributing doc is a little bit deprecated and does not contain enough information to start contributing to the project. I will modify the contributing doc to include

  1. CI Process (Especially how travis and jenkins work together)
  2. formatter is changed from shell script to https://github.com/ambv/black
  3. How to run integration test locally
  4. How to reproduce CI environment
  5. How to add submodules to the clipper_admin.

Please let me know if you can come up with any other things to add.

@rkooo567
Copy link
Collaborator Author

We also need

tutorial

  1. Kubernetes deployment (ideally with minikube)
  2. How to debug (using docker logs, fluentd, and etc.)

How to start contribute

Especially, we can expose some tasks to public

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant