spring-boot-demo VS github-docs

xkcoding / spring-boot-demo

This guide covered essential Git and GitHub for team collaboration, emphasising branching, committing, remotes, issues, and pull requests. Effective workflows, code reviews, conflict management, and distributed team practices are key for success. Further Resources: Refer to the official Git (https://git-scm.com/doc) and GitHub (https://guides.github.com/ and https://docs.github.com/) documentation, and engage with relevant tech communities.

CONTRIBUTING.md: You can reduce the amount of confusion and friction that potential contributors (and you) face by clearly defining why and how others can contribute new code, documentation, art, or other elements to your project. If the contribution steps are very simple, you might just include them in your README; but, if you find it takes more than a paragraph or two (and it usually does), it’s best to create this separate file. It should include information about the types of contributions you’re looking for, how to propose a new feature or bug fix, the process for submitting pull requests, and any specific coding standards or style guidelines contributors should follow. For a good example, take a look at the contributor guide from GitHub’s docs project.

GitHub Docs: GitHub Docs

In college, an English professor would ask me and other students the following question when reviewing our essays, “Where are the examples?” Developers ask the same question when reading your documentation. To write good technical writing documents, include examples that developers can see themselves implementing in their work. How can this be done? By adding examples from your product’s codebase! 🙂 Let’s look at this code snippet from my contribution to GitHub’s documentation:

Need an example? Check the GitHub docs contributing guide.

git clone https://github.com/github/docs.git 123.57s user 37.02s system 74% cpu 3:35.73 total

git clone --depth 1 https://github.com/github/docs.git 3.37s user 1.83s system 35% cpu 14.521 total

Not a scientific test at all, but the second one was literally 35x faster, wall clock time.

Docs