Skip to content
This repository has been archived by the owner on Jan 23, 2021. It is now read-only.

Personalize README.md #2

Open
terichadbourne opened this issue Jan 23, 2019 · 3 comments
Open

Personalize README.md #2

terichadbourne opened this issue Jan 23, 2019 · 3 comments

Comments

@terichadbourne
Copy link
Member

There's an MVP readme provided for you, but you may want to personalize it by:

  • adjusting the welcome section
  • adding additional contact info for organizers (email, Twitter, etc.)
  • calling for co-organizers to join you
  • mentioning related Meetup groups that will be hosting your ProtoSchool events
@daijiale
Copy link
Member

daijiale commented Jan 24, 2019

I have push a commit for a personalize README.md and a README-zh.md for chinese :ead6d85

Please double check the information related to you @bobjiang ,I'm afraid I might have made mistakes

By the way , I think it's better to lock the main branch and every commit need a new branch and pull request after review each other @terichadbourne @bobjiang ,what are your opinions?

@terichadbourne
Copy link
Member Author

@daijaile In general I do recommend using new branches and PRs when working on a team, so that you have a chance to confirm you agree with each other's edits, but it's up to you as co-organizers to decide what process you'd like to follow. Although I have admin privileges across all repos, I won't be actively involved in your Beijing repo, so it's probably best not to mention me within your readme.

One suggestion regarding mentioning your meetups in your repo. It looks like the "Events Review" section is about past events. Would you like to add something about how you'll be planning and publicizing future events? For example, you could say that ProtoSchool meetups will be hosted by X and Y meetup groups (with links to the main group pages, not the past events) or that planning for events will take place in your issue queue (or both!). For example, the San Francisco chapter uses an issue for planning for the next workshop, and there's a link to the issue from the readme that encourages people to help with the planning. See ProtoSchool/san-francisco#1.
This is totally up to you and @bobjiang of course, just a suggestion.

@daijiale
Copy link
Member

@daijaile In general I do recommend using new branches and PRs when working on a team, so that you have a chance to confirm you agree with each other's edits, but it's up to you as co-organizers to decide what process you'd like to follow. Although I have admin privileges across all repos, I won't be actively involved in your Beijing repo, so it's probably best not to mention me within your readme.

One suggestion regarding mentioning your meetups in your repo. It looks like the "Events Review" section is about past events. Would you like to add something about how you'll be planning and publicizing future events? For example, you could say that ProtoSchool meetups will be hosted by X and Y meetup groups (with links to the main group pages, not the past events) or that planning for events will take place in your issue queue (or both!). For example, the San Francisco chapter uses an issue for planning for the next workshop, and there's a link to the issue from the readme that encourages people to help with the planning. See ProtoSchool/san-francisco#1.
This is totally up to you and @bobjiang of course, just a suggestion.

Got it , I was going to have an area where I could put all the resources together for review,But it doesn't fit event info,I will add the event plan to be held later ,Thanks for suggestion

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

No branches or pull requests

2 participants