documentation
Documentation writing at AnitaB.org Open Source organization level. (by anitab-org)
readme
Examples of README files and notes about how to write them. (by inessadl)
documentation | readme | |
---|---|---|
2 | 1 | |
18 | 45 | |
- | - | |
0.0 | 0.0 | |
over 1 year ago | 5 months ago | |
MIT License | - |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
documentation
Posts with mentions or reviews of documentation.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2021-09-04.
-
Sync fork with original repository using git
To use as an example, I forked anitab-org/documentation repository into my GitHub account isabelcosta/documentation. When cloning the repository I used the SSH URL of my forked repository. The commands I’ll mention will be running against the repository’s default master branch.
-
Contributing to Open Source with Quality Assurance
A guide to contributing to Quality Assurance in our projects; We also have a PR test report template we encourage our contributors to use when testing a PR;
readme
Posts with mentions or reviews of readme.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-06-20.
-
report bout my project
If it’s for a class, ask the instructor for an expected outline or an example and follow it. If it’s for a job application or coding portfolio, here are some readme examples https://github.com/inessadl/readme
What are some alternatives?
When comparing documentation and readme you can also consider the following projects:
mentorship-backend - Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the backend of this system.