The How-to guides are not completed right now. So, my suggestion is to add a badge/banner like the below one as a placeholder to every markdown files in How-to/guide/ folder 👇
Badges
Banners
I created the pattern for the WIP banner. You can use this pattern to create your own banner image 👇
We are adding a guide/process for every activity (Creating a PR, raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of how to create a PR, steps will contain a text, screenshot, Video (it can be screen recording to show the steps) and GIF (if needed)
This issue is for adding the guide/process for How to use GitHub Pages. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding a guide/process for How to add a social preview to a repo. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding the guide/process for How we can delete a repo. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of " How to assign an issue to someone", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to link and issue no with a PR", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
This issue is for adding the guide/process for How to create a Releases - manually. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
There is an issue in Pages/Regular.md file in the first 2 links or the Twitter links mentioning and redirecting to different post. I think both of them were replaced wrongly. Please have a look. I also have made appropriate changes.
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to start a github discussion", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
Hello, @Pradumnasaraf I just found some documentation as well as bug improvement in the cloning repo file. I think a direction about copy-paste in Git Bash needs to be added with an image. It will be good for a beginner not to be stuck for a moment(as I did not knew when I used ctrl + v). Can I add that?
Hello Pradumna,
As you know, I am new to Open Source & learning how to contribute. I came across your instructions on how to raise a bug but the below documentation contains typo which I have highlighted in brackets & below I have also shared the best way to communicate your intended message.
--> When you click on (New Issue , you will get a list of 4 types of issues.)
-> If you find any bug in the repository feel free to click on (Get Started') and you will get a template and then in the description, ellaborate the bug.)
-> (Try to add some screenshots of the bug so that it will be easy for the maintainer to understand and then react.)
Solution -> Below mentioned is a better way to communicate the same without any typos or repeated words -
--> When you click on 'New Issue', you are prompted with 4 types of issues -
-> If you find any bug in the repository, feel free to click on 'Get Started' and you will get a template in which you write a crisp/short title of the bug.
In the 'Description' section, please elaborate the details of the bug you encountered.
-> In the 'Screenshots' section, please add some screenshots of the bug to make it easy for the maintainer to understand and make necessary changes.
I hope you accept my suggestions & make necessary changes to the documentation.
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to create an Issue", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to clone a repo", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "Adding sponser to a repo", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
This issue is for adding a guide/process for How to create GitHub secrets. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding the guide/process for How to archive a repo. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of ""How to create a PR"", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to create issue templates", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
I have a repo, called Free Hosting Via PR to make it easier for beginners and advanced coders, to get hosting on the web, for free without wasting time, finding a hosting service, etc, so they can focus on coding.
Some beginners although, may not know how to make a PR, so I wanted to know if it would be fine if I link the file from this repo creating-pr.md in that repo.
This issue is for adding the guide/process for How to make a repo private/public. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding the guide/process for How to create a licence. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding the guide/process for How to create to create GitHub project board. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
This issue is for adding the guide/process for How to create a Tags. The step needs to be well defined and include the Screenshot/Screen recording for better explanation. To get an overview of how the docs should look, check the available docs here
Just checked your recent commits to the repo. The job that you are doing really helped me the last few days to make myself more sound about how and what actually happens while fork, raising a PR, etc. As I see you have covered many basic, core topics. What I felt was difficult while learning is the concept of git stash, squashing the repo, and concepts like upstream, git rebase and git reset. It will be a cherry on the cake if you add this topic in the repo and blogs as soon as possible. As I have also seen many of my friends struggle with these concepts.
We are adding a guide/process for every activity (like Creating a PR or raising an issue) and making learning easy for new contributors.
Changes/Action required
Add a complete process of "How to review a PR", steps will contain a text, screenshot, Video (it can be a screen recording to show the steps), and GIF (if needed)
In the pages/Beginners, the spelling of the word beginner in the title "Beginnner friendly projects" is misspelled.
Also, I'm suggesting to put a hyphen between Beginner and friendly (Beginner-friendly). I think it's a compound word.
I don't know if I will be completely right or not. But I will still raise an issue.