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

Project Template README needs a re-write #482

Open
geekygirldawn opened this issue Aug 7, 2023 · 9 comments
Open

Project Template README needs a re-write #482

geekygirldawn opened this issue Aug 7, 2023 · 9 comments

Comments

@geekygirldawn
Copy link
Member

Someone recently pointed out that the big green button on the README doesn't do anything, so we need to fix that. I'm not sure what it was supposed to do - fork the repo? something else? I'm sort of inclined to remove it now that we have so many optional templates / variations. @jberkus - what do you think?

But, after looking at that README, I think we also need to re-write some of the text. In particular, we need to point to the how-to guides, and we can probably include some other hints / tips to help people get started.

@ikemecloud
Copy link

Hi, I submitted a PR with fixes to the points you raised in this Issue

@riaankleinhans riaankleinhans moved this from 🆕 New to Blocked in TAG Contributor Strategy Project Board Aug 20, 2023
@riaankleinhans riaankleinhans moved this from Blocked to 📋 Backlog in TAG Contributor Strategy Project Board Aug 20, 2023
@IvyJeptoo
Copy link

IvyJeptoo commented Aug 21, 2023

Hello @geekygirldawn has this issue been worked on? I'd like to work on it

@SaxenaAnushka102
Copy link

Hello @geekygirldawn! I'd like to take this issue up. If no one's working on this please assign it to me!

@geekygirldawn
Copy link
Member Author

After looking at this issue a bit more, I've removed the "help wanted" label. Unfortunately, this README needs a complete re-write, but it needs to come from someone who has knowledge of what TAG Contributor Strategy has been working on over the past year or so because we've developed a bunch of new materials and different processes that people should follow now, and those need to be reflected in this readme.

@Riaankl or @aliok - is this something you'd be interested in tackling? I also think maybe we should wait until we have the governance self-assessment doc published?

@riaankleinhans
Copy link
Contributor

@geekygirldawn , @jberkus @aliok
I can do this next.
Next step for Governance that I was looking a addressing was to make a documents & requirements (Compulsory & Optional) matrix for project maturity levels, which tie in with the "Projects Moving Levels" meeting taking place tomorrow.
These docs can then roll over into the self assessment guide.

@riaankleinhans riaankleinhans self-assigned this Aug 22, 2023
@riaankleinhans riaankleinhans moved this from 📋 Backlog to 🔖 Assigned in TAG Contributor Strategy Project Board Aug 22, 2023
@riaankleinhans
Copy link
Contributor

@IvyJeptoo @SaxenaAnushka102
Help is always wanted. This issue does requier some background knowledge.

There are however several issues on our Project board where help is wanted.
Please have a look throught those.
Another great way to get involved it to attend our meetings.
Next Contributor Growth meeting is August 24, 2023, Thursday at 10am Pacific Time. You can look at our agenda for more information.

@IvyJeptoo
Copy link

IvyJeptoo commented Aug 22, 2023

Thank you so much @Riaankl The pointer is of great help! I have checked the project board and all the issues are tagged with help wanted which makes me think it will be the same as the above in the sense that it requires background knowledge.

As someone who is new to contribution, how do I go about getting issues that I can be able to contribute to?

@riaankleinhans
Copy link
Contributor

@IvyJeptoo If you look at the top if the project board, there are several tabs. The link that I sent you is for the table that filtered to only show issues with "Help wanted" lables. You can click through the tabs to see other filtered issues.
Join us in the Contributor Strategy WG meeting then we can have a discussion about issues that match your knowledge / skill / interest.

@IvyJeptoo
Copy link

Thank you so much @Riaankl I've understood. I will surely join the meeting

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🔖 Assigned
Development

No branches or pull requests

5 participants