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

Review/extend DEVELOPMENT documentation #182

Closed
Tracked by #133
dholbach opened this issue Oct 18, 2021 · 5 comments
Closed
Tracked by #133

Review/extend DEVELOPMENT documentation #182

dholbach opened this issue Oct 18, 2021 · 5 comments
Assignees

Comments

@dholbach
Copy link
Member

Each of the controllers should have clear guidelines on how to build and run the
projects. This includes the sections:
○ How to install dependencies
○ How to install the controller
○ How to run the test suite locally
○ How to run the controller locally

Some of the information might already be there - let's double-check it's up to date and accurate.

@dholbach
Copy link
Member Author

Please note: the document has moved to https://github.com/fluxcd/image-reflector-controller/blob/main/DEVELOPMENT.md now

@dholbach
Copy link
Member Author

This issue might be well-suited for new contributors. Basically the ask is: if you have a fairly clean installation of whatever your OS is: let us know if the instructions in the file above were everything that's needed to get you going on the individual tasks. Please report back if you ran into issues and the docs should be clearer (or make a PR!). Thanks a lot in advance!

@tomhuang12
Copy link
Contributor

I would like to work on this.

@tomhuang12
Copy link
Contributor

PR is created. Please review when you have a chance. Thanks!

@dholbach dholbach changed the title Review/extend CONTRIBUTING documentation Review/extend DEVELOPMENT documentation Nov 10, 2021
@kingdonb
Copy link
Member

kingdonb commented Jan 6, 2022

#215 should have addressed this in full for image-reflector-controller. 👍

@kingdonb kingdonb closed this as completed Jan 6, 2022
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

3 participants