Skip to content

fix and update CONTRIBUTING.md #735

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

Closed
wants to merge 1 commit into from

Conversation

asavahista
Copy link
Contributor

basically a draft - there is still a lot that potentially needs to be changed.
for example the roadmap was last updated 3 years ago (and the link is to the closed roadmap issue - maybe the link could be changed to one of the projects instead).
actually, most of the doc is still 3 years old so it might be worth going over the entire thing to make sure the overview is complete and correct

ocaml#702 made CONTRIBUTING.md a bit wonky.
fixed/added some links, removed others to match current source tree
xref was replaced with xref2 in 86e7c67 - not sure if the text is still accurate
@lubegasimon
Copy link
Collaborator

Thanks for your efforts @asavahista, indeed documentation pull requests are a real deal. Though I’m certainly not sure of how much of this content will be overwritten by #733.

@asavahista
Copy link
Contributor Author

ah, indeed it's completely obsoleted by that

@asavahista asavahista closed this Sep 23, 2021
@asavahista asavahista deleted the update-contributing branch September 23, 2021 19:36
@jonludlam
Copy link
Member

Thanks for the contribution anyway, @asavahista. Just bad timing that it came when we're overhauling lots of docs! Or good timing if you look at it another way: I'm looking for feedback on that docs PR - would you care to take a look over them and see if they look OK?

@asavahista
Copy link
Contributor Author

@jonludlam yeah, actually i've already been looking around a bit - just a heads up though, i'll probably only be looking for (possible) syntactic errors first as those are easier to find than semantic errors

@jonludlam
Copy link
Member

That'd be great, thank you!

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

Successfully merging this pull request may close these issues.

3 participants