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

Rewrite contribution guide and CONTRIBUTING.md #2780

Closed
cl8n opened this issue Nov 6, 2019 · 8 comments · Fixed by #6154
Closed

Rewrite contribution guide and CONTRIBUTING.md #2780

cl8n opened this issue Nov 6, 2019 · 8 comments · Fixed by #6154
Assignees
Labels
area:meta non-article files

Comments

@cl8n
Copy link
Member

cl8n commented Nov 6, 2019

should be reorganized and combined in some way. the github+git tutorial can be its own page cuz a lot of potential contributors are familiar with these already. also I feel like github has their own documentation for that but I haven't looked into it yet

they also assume the reader wants to make changes themselves (and that they know exactly what to change), which often isn't the case

@cl8n cl8n added the rewrite label Nov 6, 2019
@sr229
Copy link
Contributor

sr229 commented Nov 6, 2019

I think some contributors are not even aware how to use Git or GitHub in general so I think a linkback on the learning resources they need is still essential

@MegaApplePi MegaApplePi added this to the Candidate Issues milestone Nov 10, 2019
@cl8n cl8n modified the milestones: Candidate Issues, December 2019 Nov 20, 2019
@cl8n
Copy link
Member Author

cl8n commented Nov 29, 2019

from a pm
[12:13 AM] Benzopirene: and the tutorial on the site is great, but it lacks like FAQ section perhaps?
[12:14 AM] Benzopirene: the best thing to do for beginner is to ask

not sure about FAQ format specifically, but dispelling common misconceptions/mistakes is a good idea. and messaging somewhere in real time (#osu-wiki preferred, maybe list some osu/discord IDs too) should be encouraged if problems come up cuz it's usually more annoying for everyone to deal with them after PRs are already open

@cl8n
Copy link
Member Author

cl8n commented Dec 6, 2019

should include some help for translators specifically, and explain how you can view new changes with
git log {outdated_since}~1..master {article}/en.md
because not all translations are perfectly accurate with english

@Pennek
Copy link
Contributor

Pennek commented Jan 29, 2020

here's my pov as someone who is very new to contributing:

  • the Contribution Guide although messy, was an okay starting point. It helped me set up my branches and how to create PRs. But not much more than that... definitely needs a rewrite with focus on being concise
  • Adding links to discord, and telling people to communicate there is a great idea.

As for me, I kinda "knew" #osu-wiki existed, but since all I saw were regular contributors writing in there it was kind of intimidating. Explaining that it is okay to be new and ask questions in there is a great first step. I've learnt way more from communication in #osu-wiki than anywhere else.

@Endaris
Copy link

Endaris commented Feb 2, 2020

I've looked into the contribution guide yesterday and found that it was drastically simplified compared to the original wall but it mostly covers the technical side of how to work with the github page to submit contributions.
What is unclear to me is this entire system of issues, tags, priorities etc. Where do i start?
Navigating github to look into pinned issues or filtering tags is not something that is intuitive to do with that information being nowhere readily available. Knowing what exactly to edit is (for me as a potential new contributor) harder than actually making edits to sites.

@TicClick
Copy link
Contributor

this is something I wanted to do, may take a look in the following days/weeks

@TicClick
Copy link
Contributor

this should also cover #1988, quote from sr229:

To better educate new contributors on the flow in GitHub, I think we can mention some courses in GitHub Learning Labs created by the GitHub team themselves.

They usually cover in detail a lot of things we also cover such as merge conflicts, a introductionary to the GitHub interface, along with the basic fundamentals of Git.

@TicClick
Copy link
Contributor

passing by to say I've started the rewrite, which also covers Common Issues. will get it done within the next two weeks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:meta non-article files
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants