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.

Sign up for GitHub

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

Jump to bottom

Contributing guidelines link redirects to an unrelated page #212

Closed
znewman01 opened this issue Jan 26, 2022 · 1 comment · Fixed by #309
Closed

Contributing guidelines link redirects to an unrelated page #212

znewman01 opened this issue Jan 26, 2022 · 1 comment · Fixed by #309
Assignees
@znewman01
Labels
bug documentation

Comments

@znewman01
Copy link
Contributor

The current contributing guidelines link to the Flynn contributing guide. However, the link redirects to the root of the archived flynn/flynn repository.

We could change the link to point to CONTRIBUTING.md in flynn/flynn, but I'm not entirely sure that's appropriate:

  1. There's a lot of references to the Flynn team, IRC channel, etc.
  2. Some of the practices (e.g., "Ensure that each commit has a subsystem prefix (ex: controller:)", DCO) aren't being followed.

I can write a quick CONTRIBUTING.md file including:

  • intro: we welcome contributions etc.
  • PR procedure, LGTM requirement, etc.
    • Go/project specific guidelines: gofmt -s, go test ./...
  • TUF code of conduct (which just points to the CNCF code of conduct)

if that sounds good.
@joshuagl
Copy link
Member

Thanks for the report @znewman01! @asraa already started working on addressing this in #190, would appreciate your feedback on her proposal there.

@joshuagl joshuagl linked a pull request Jan 26, 2022 that will close this issue
docs: Add contributing guidelines for go-tuf #190
Closed
@rdimitrov rdimitrov moved this from 🆕 New to 🏗 In progress in [go-tuf] Project planning - v0.6.0 (Target: 2022-11-30) Jun 8, 2022
znewman01 added a commit to znewman01/go-tuf that referenced this issue Jun 8, 2022
@znewman01
Update CONTRIBUTING.md, add MAINTAINERS.md
a2f92c4 
Follow-up from theupdateframework#190 (thanks @asraa!).

I did not add a DCO requirement at this point, as that was controversial
in theupdateframework#190. I filed theupdateframework#308 to track that.

I tried to address all *other* feedback in theupdateframework#190.

Fixes theupdateframework#212.

Fixes theupdateframework#306.
@znewman01 znewman01 mentioned this issue Jun 8, 2022
Merged
@asraa asraa closed this as completed in #309 Jun 9, 2022
asraa added a commit that referenced this issue Jun 9, 2022
@znewman01 @asraa
docs: Update CONTRIBUTING.md, add MAINTAINERS.md (#309)
1684c68 
* add contrbuting guidelines

Signed-off-by: Asra Ali <[email protected]>

* Update CONTRIBUTING.md, add MAINTAINERS.md

Follow-up from #190 (thanks @asraa!).

I did not add a DCO requirement at this point, as that was controversial
in #190. I filed #308 to track that.

I tried to address all *other* feedback in #190.

Fixes #212.

Fixes #306.

* Move docs into a "docs" folder.

Fixes #303.

* Whitespace fixes

* Address PR comments

- TODO for testing instructions
- Remove obsolete TODO

* Full URL in testing

* Fix @joshuagl suggestions

Co-authored-by: Asra Ali <[email protected]>
@rdimitrov rdimitrov moved this from 🏗 In progress to ✅ Done in [go-tuf] Project planning - v0.6.0 (Target: 2022-11-30) Jun 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@znewman01 znewman01

Labels
bug documentation
Projects
No open projects
[go-tuf] Project planning - v0.6.0 (Target: 2022-11-30)
Status: ✅ Done
Milestone
No milestone
3 participants
@znewman01 @joshuagl @rdimitrov