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

[cranelift] CONTRIBUTING.md is a dead link #1280

Closed
jyn514 opened this issue Mar 11, 2020 · 6 comments
Closed

[cranelift] CONTRIBUTING.md is a dead link #1280

jyn514 opened this issue Mar 11, 2020 · 6 comments

Comments

@jyn514
Copy link
Contributor

jyn514 commented Mar 11, 2020

Probably got lost in the switch to wasmtime. cranelift/README.md links to cranelift/CONTRIBUTING.md, but there's no file there. Not sure whether you want this to link to CONTRIBUTING.md or something in cranelift/docs, so I didn't make a PR.

@abrown
Copy link
Contributor

abrown commented Mar 11, 2020

Linking to the wasmtime-level CONTRIBUTING.md would make sense to me.

@jyn514
Copy link
Contributor Author

jyn514 commented Mar 11, 2020

Is there a reason not to add back the old CONTRIBUTING.md file? https://github.com/bytecodealliance/cranelift/blob/3d1cdec0837684b1656bcb6194be6c31302b5d3e/CONTRIBUTING.md

@abrown
Copy link
Contributor

abrown commented Mar 11, 2020

I suspect it was removed to remove duplication; @alexcrichton?

@abrown
Copy link
Contributor

abrown commented Mar 11, 2020

@jyn514, what does the cranelift file have that is missing in the wasmtime file? (I mean what information do you feel is important and missing?)

@jyn514
Copy link
Contributor Author

jyn514 commented Mar 11, 2020

Actually, looking back at both it seems like they cover most of the same info, so I'd be ok with only keeping the wasmtime website. I was a little put off by most of the sections on the website being missing, but 10. Contributing all seems to be there.

@alexcrichton
Copy link
Member

Oh oops sorry about the broken link! I removed the one in cranelift and merged it with the wasmtime contributing docs. The top-level CONTRIBUTING.md is just a thin shim pointing to those docs. I figured there wasn't much use in having two CONTRIBUTING.md files, but I think it's fine for the README to point directly to the online docs!

sunfishcode added a commit that referenced this issue Mar 23, 2020
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