search

JoelPickin / ProjectOMatic

An introduction to open-source and technical writing for developers of every level and skill set.
https://project-o-matic.herokuapp.com/
MIT License
8 stars 1 forks source link

Improve README file #3

Open ghost opened 2 years ago

ghost commented 2 years ago

I wanted to improve the information in Open Source Section.

Contributing to open-source is well-known to help developers in several ways.

  1. It strengthens resumes, adding real projects you can discuss in interviews.
  2. Improves coding ability, as it allows you to practice your skills, as well as adhere to someone else coding standards.
  3. Gives experience akin to working in a development environment, as you have to read and understand someone else's code and open yourself up to feedback when your code is reviewed. As much as it has many positives, contributing to open-source can be a daunting task for anyone new to it, especially someone who is just getting to grips with the coding fundamentals. Alongside finding projects to contribute to, it can be an intimidating experience opening yourself up to scrutiny and learning the ins and outs of how GitHub works. This is where the Project-o-Matic open-source collaboration effort can help. It is a welcoming project for developers of all levels. You offer the chance to get to grips with the GitHub UI/process and make their first open-source contribution. Projects are loaded via local markdown files added to the app, and solutions are added via a JSON file. These are the ways you can make your first contributions. If you want to find out more or steps on how to contribute, head over to the GitHub page. Read below on how you can improve your technical writing using Hashnode.

Several changes in grammar and clarity. What do you think? If it suits you, would you assign me to this issue? I am new to open source projects and have minimum skills in HTML and CSS, so this is the best I can do now. Thank you!

JoelPickin commented 2 years ago

Apologies for the late response, I have been travelling for the past few days.

Looks great to me. Glad to see you getting involved regardless of your current abilities. Happy for you to look at any of the other sections that may need work.

I know I need to improve the explanations of how to contribute, I am considering doing a screen-recorded walkthrough as this would make it much easier for newer developers.

ghost commented 2 years ago

No worries, @JoelPickin. I am glad you made it to my issue. Safe travel!

I'll try to work accordingly and finish it this weekend. Maybe you can later use the text I provide for your guidance to make some videos or pre-recorded gifs for the readme