Skip to content

Make README user-friendly #2

@sergray

Description

@sergray

Current version of README.md lists a few basic git commands and briefly describes them.

README files should provide a meaningful context to the readers, so it might be better to move the list of the commands to separate file and write a section in README file describing creation of an empty repository on GitHub and adding a README file to it.

Please do these changes on a separate branch, create a pull request (PR) to the main branch and add me as a reviewer.

The goal of this assignment is to:

  • recall the process for creating new repository on GitHub
  • use git CLI commands for cloning repository locally, adding new file, committing and pushing the changes
  • use branching model with code review for development

It might be good to make the notes of the process (especially all bottlenecks and solutions to them) while working on these issue, so it can be added as a second section to README later.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions