-
- Notifications
You must be signed in to change notification settings - Fork 341
Description
Hi everyone,
I am in the final year of a computer science program and one of the classes I am taking this quarter is an Open Source Software class. It’s always been something that I’ve wanted to do, but now it’s actually required by my class to contribute to an Open Source project. I’m both a newcomer to Go and contributing to Open Source so I’ve found the task a bit daunting. I’ve looked at a few other projects but what drew me to script is that fact that it’s in Go, and I thought it’d be a great way to improve with Go, use it on real-world projects, and get more involved with the Go community. As a new contributor I am a bit intimidated on where to start so it’s unlikely that I’ll actually contribute Go code, but I’m not ruling it out. Since learning more about Open Source in my class I think there are a few areas that I could help contribute:
Contributor documentation:
- More comprehensive documentation
- Code of Conduct
- More examples
- Tutorials / How-to-guides
- Examples of testing
- Style guide
o Show good code vs bad code - Slack/Chat IRC for the contributor community
- Email for the project
- Bug tracker
User documentation:
- Project website to centralize information for this project. Could be used for contributor stuff as well.
- Installation instructions
o “$go get …” etc.
I realize that I myself probably cannot implement all of these things, but I wanted to raise these ideas and see what everyone else thinks, in case anyone else wants to try implementing them. I hope these suggestions are not perceived as pitfalls or anything wrong with the current state of the project, just potential improvements that could help make the project more inviting for a newcomer like myself, who has no idea where to start. If there's anything that comes to mind that you think would be a good first task for a newbie, feel free to let me know as well 😊