hello-world
hello-world copied to clipboard
Contributing guidelines
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
.
I just realised something. The translated READMEs need to be updated too. How do we go about that?
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.
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
if there is anything I can do to help, please let me know.
Ping @muan . Can we help over here?
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 Hello, I would be happy to contribute and create said CONTRIBUTING.md