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

Contribution Guidelines #1

Open
tlkh opened this issue Oct 3, 2018 · 6 comments
Open

Contribution Guidelines #1

tlkh opened this issue Oct 3, 2018 · 6 comments
Assignees

Comments

@tlkh
Copy link
Member

tlkh commented Oct 3, 2018

As an example: https://gist.github.com/PurpleBooth/b24679402957c63ec426

I'm thinking a separate code of conduct document is still a good idea though. In which case:

  • CONTRIBUTING: Guides for Project Submission, or contributing to current OpenSUTD projects. Include some git usage tips and guide, and the typical disclaimers what NOT to contribute. This page will be highlighted by GitHub automaticallly.
  • CONDUCT: Code of conduct document, mostly common sense. Assume that people are generally nice and should be following it even if they did not explicitly read it, so we don't need to serve it in people's face except if there is a "problem" somewhere.

Let's get this worked out ASAP.

@welcome
Copy link

welcome bot commented Oct 3, 2018

Thanks for opening your first issue here! Please check out our contributing guidelines and code of conduct.

@tlkh
Copy link
Member Author

tlkh commented Oct 3, 2018

Haha and let's have another discussion on some automation on the OpenSUTD repos. (See welcome-bot above haha)

@joel-huang
Copy link
Member

There are some primitive guidelines I created on the original OpenSUTD repo for contribution and conduct. Those might be useful as a starting point, but we can have a permanent open discussion here to make sure they're relevant as the community & platform evolves.

@Fishbiscuit
Copy link
Member

Fishbiscuit commented Oct 4, 2018

Updated the documents with proposed guidelines.

Suggest we need

  1. Some sort of theme for our internal openSUTD documents. much like how ROOT has GRASS or everything from apple starts with an 'i'
  2. Key repositories for common accessed materials
  3. Set up the roles and responsibilites of the Community architects and tech evangelists

Let's take the chance to source ideas during GRASS on 9/10/2018

@methylDragon
Copy link
Contributor

methylDragon commented Mar 16, 2019

I suggest splitting the contribution guides into its own repo for visibility purposes wrt. the pinned repositories. It'll make it easier to onboard people as well.

Can I also recommend putting project nomenclature under the contribution guide. We should make it a one-stop shop.

@tlkh
Copy link
Member Author

tlkh commented Mar 16, 2019

Agree with @methylDragon that given how important this is, let's give it more visibility.

In addition, there's still work to be done, so recommend continuing on work in #3

@joel-huang joel-huang pinned this issue Apr 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants