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 #265

Closed
Tracked by #133
dholbach opened this issue Oct 18, 2021 · 3 comments · Fixed by #309
Closed
Tracked by #133

Review/extend DEVELOPMENT documentation #265

dholbach opened this issue Oct 18, 2021 · 3 comments · Fixed by #309
Labels
area/docs Documentation related issues and pull requests good first issue Good for newcomers

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 this file has moved to https://github.com/fluxcd/notification-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!

@makkes makkes added area/docs Documentation related issues and pull requests good first issue Good for newcomers labels Oct 29, 2021
@dholbach dholbach changed the title Review/extend CONTRIBUTING documentation Review/extend DEVELOPMENT documentation Nov 10, 2021
@yiannistri
Copy link
Contributor

yiannistri commented Jan 4, 2022

I'd like to have a go at this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants