Expand CONTRIBUTING.md to help new contributors #1516

jonah · 2019-11-24T09:29:51Z

dawidpotocki commented

2019-11-24 09:29:51 +00:00

(Migrated from github.com)

Installation, building, file/directory structure, submitting patches

Rendered - https://github.com/dawidpotocki/privacytools.io/blob/contributing/CONTRIBUTING.md

Installation, building, file/directory structure, submitting patches Rendered - https://github.com/dawidpotocki/privacytools.io/blob/contributing/CONTRIBUTING.md

netlify[bot] commented

2019-11-24 09:30:27 +00:00

(Migrated from github.com)

Deploy preview for privacytools-io ready!

Built with commit 4f9b9cddd48d451d678ce305947d45496bdeaa64

https://deploy-preview-1516--privacytools-io.netlify.com

Deploy preview for *privacytools-io* ready! Built with commit 4f9b9cddd48d451d678ce305947d45496bdeaa64 https://deploy-preview-1516--privacytools-io.netlify.com

netlify[bot] commented

2019-11-24 09:30:59 +00:00

(Migrated from github.com)

Deploy preview for privacytools-io ready!

Built with commit 2219b5d634

https://deploy-preview-1516--privacytools-io.netlify.com

Deploy preview for *privacytools-io* ready! Built with commit 2219b5d63479b5fb37687d302d3332cd4f8f2a3b https://deploy-preview-1516--privacytools-io.netlify.com

dngray (Migrated from github.com) reviewed 2019-11-24 09:37:13 +00:00

Mikaela (Migrated from github.com) requested changes 2019-11-24 09:50:41 +00:00

Mikaela (Migrated from github.com) left a comment

Why are you moving the file from .github/CONTRIBUTING.md to CONTRIBUTING.md which prevents seeing a clean diff?

How about first you do the changes you wish and in another PR rename the file if you have a very good reason of doing that?

Why are you moving the file from .github/CONTRIBUTING.md to CONTRIBUTING.md which prevents seeing a clean diff? How about first you do the changes you wish and in another PR rename the file if you have a very good reason of doing that?

jonah commented

2019-11-24 19:58:48 +00:00

I agree it doesn’t make sense to me to move repo files out of .github.

I agree it doesn’t make sense to me to move repo files out of `.github`.

dawidpotocki commented

2019-11-25 02:15:43 +00:00

(Migrated from github.com)

I agree it doesn’t make sense to me to move repo files out of
.github

And for me it makes crap ton of sense. CONTRIBUTING.md is not GitHub
specific. Just like we have README.md and LICENSE.txt at the root of
repository, even though they can be placed in .github. It makes it
easier to find, because it was before in a hidden directory, for which
I'm never looking for when I clone the project and it will still be
detected by GitHub. I don't see a reason for it staying there.

> I agree it doesn’t make sense to me to move repo files out of > `.github` And for me it makes crap ton of sense. CONTRIBUTING.md is not GitHub specific. Just like we have README.md and LICENSE.txt at the root of repository, even though they can be placed in `.github`. It makes it easier to find, because it was before in a hidden directory, for which I'm never looking for when I clone the project and it will still be detected by GitHub. I don't see a reason for it staying there.

jonah requested changes 2019-11-30 08:13:33 +00:00

jonah left a comment

Your headers don't match your table of contents, and therefore the links won't work. Also, not sure why you are using hard text wrapping and
instead of Markdown's double-newline for line breaks.

Your headers don't match your table of contents, and therefore the links won't work. Also, not sure why you are using hard text wrapping and <br /> instead of Markdown's double-newline for line breaks.

freddy-m commented

2020-09-30 14:28:50 +00:00

(Migrated from github.com)

@privacytools/editorial I removed Dawid's assignment to this, should we still continue with it ourselves?

👍 1

dngray commented

2020-10-01 03:58:53 +00:00

(Migrated from github.com)

@privacytools/editorial I removed Dawid's assignment to this, should we still continue with it ourselves?

I guess so, I haven't looked into it in too much detail.

> @privacytools/editorial I removed Dawid's assignment to this, should we still continue with it ourselves? I guess so, I haven't looked into it in too much detail.

This repo is archived. You cannot comment on pull requests.

No reviewers

Mikaela