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

Contributing guidelines #98

Open
muan opened this issue Apr 25, 2017 · 7 comments
Open

Contributing guidelines #98

muan opened this issue Apr 25, 2017 · 7 comments

Comments

@muan
Copy link
Owner

muan commented Apr 25, 2017

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.

@SubhrajyotiSen
Copy link
Collaborator

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

@muan
Copy link
Owner Author

muan commented May 2, 2017

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.

@aaossa
Copy link
Contributor

aaossa commented May 2, 2017

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

@SubhrajyotiSen SubhrajyotiSen removed their assignment Jun 23, 2017
@ghost
Copy link

ghost commented Jul 24, 2017

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

@aaossa
Copy link
Contributor

aaossa commented Aug 23, 2017

Ping @muan . Can we help over here?

@muan
Copy link
Owner Author

muan commented Aug 25, 2017

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.

@ap1459
Copy link
Contributor

ap1459 commented Jan 25, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants