hello-world icon indicating copy to clipboard operation
hello-world copied to clipboard

Contributing guidelines

Open muan opened this issue 7 years ago • 7 comments

See https://github.com/blog/1184-contributing-guidelines.

The contributing part in the README content should follow the convention and be moved into files called CONTRIBUTING.

muan avatar Apr 25 '17 10:04 muan

I just realised something. The translated READMEs need to be updated too. How do we go about that?

SubhrajyotiSen avatar May 02 '17 09:05 SubhrajyotiSen

What do you think about consolidating every language into one file for both README and CONTRIBUTING? On the top of each file we can still have a table of contents for each language, but each language section is separated with <hr> and a heading (anchor).

They could potentially turn into a big long files,.. but it seems manageable for the moment. 🤷 It would also be more obvious that instructions in different languages exist.


Alternatively we can just have CONTRIBUTING-zhTW and others and have them all linked from the default English one.

muan avatar May 02 '17 10:05 muan

I like the second solution. The first one doesn't solve the issue to me (that says that Contributing should have its own file).


Another option is to split just the English version to have just one CONTRIBUTING.md and every translation have a section for Contributing

aaossa avatar May 02 '17 11:05 aaossa

if there is anything I can do to help, please let me know.

thatSOkid97 avatar Jul 24 '17 21:07 thatSOkid97

Ping @muan . Can we help over here?

aaossa avatar Aug 23 '17 12:08 aaossa

The first one doesn't solve the issue to me (that says that Contributing should have its own file).

What do you mean by it doesn't solve the issue? We will have README.md & CONTRIBUTING.md, it's just that all translations live under one(README or CONTRIBUTING) file.

muan avatar Aug 25 '17 02:08 muan

@muan Hello, I would be happy to contribute and create said CONTRIBUTING.md

ap1459 avatar Jan 25 '18 19:01 ap1459