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

docs: Add CONTRIBUTING.md file #452

Merged
merged 1 commit into from Jan 3, 2022

Conversation

erikmd
Copy link
Member

@erikmd erikmd commented Nov 2, 2021

This commit refactors and extends the text from:
https://github.com/ocaml-sf/learn-ocaml/wiki/Checklist-for-testing-and-merging-a-PR
which mostly results from standard conventions + those that are necessary because of the release-please dependency.

Proofreading is welcome!
(Cc @yurug @AltGr FYI)

Direct link to the rendered .md [updated]

@erikmd
Copy link
Member Author

erikmd commented Nov 2, 2021

BTW I just noticed that when a CONTRIBUTING.md file is present, there will be a special page at URL

https://github.com/:organization/:project/contribute

automatically generated with a link to that file + the issues tagged good first issue, see e.g.:

https://github.com/coq/coq/contribute

@erikmd
Copy link
Member Author

erikmd commented Nov 2, 2021

erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Dec 6, 2021
This patch,
just required if PR <ocaml-sf#453>
is merged before PR <ocaml-sf#452>,
can be reverted anytime soon.
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Dec 14, 2021
This patch,
just required if PR <ocaml-sf#453>
is merged before PR <ocaml-sf#452>,
can be reverted anytime soon.
yurug pushed a commit that referenced this pull request Dec 21, 2021
* docs: Refactor `.github/ISSUE_TEMPLATE/*`

* Use <!--HTML comments--> more often & Tweak details

* docs: Add `PULL_REQUEST_TEMPLATE.md`

* chore: Temporarily fix `CONTRIBUTING.md` broken link

This patch,
just required if PR <#453>
is merged before PR <#452>,
can be reverted anytime soon.
@erikmd erikmd force-pushed the add-contributing.md branch 2 times, most recently from f5ba0ba to ce9757c Compare December 21, 2021 16:21
@yurug
Copy link
Collaborator

yurug commented Jan 3, 2022

LGTM!

@yurug yurug merged commit 6e3fa0f into ocaml-sf:master Jan 3, 2022
@erikmd erikmd deleted the add-contributing.md branch January 3, 2022 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants