Example and comments about a git repository for project in our collaborative group.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gmarx aa2b966e30 issues labels added 3 years ago
Readme.md issues labels added 3 years ago

Readme.md

Readme

Basic Instructions of Repository

This is the main repository of your project, please consider to follow the next rules to work in a collaborative way with other fellows.

Readme and Wiki

Use Readme.md file to let others know how to use, connect (circuits) or implement the repository elements in a basic and simple way. For detailed information, remark notes, tutorials, or documentation (reports and thesis) of the repository use the Wiki Tab in the same repository.

Considers that the Wiki page is not considered by the git system.

Projects and Issues tab

To organize your progress, use the issues and projects tabs. In this way, it is possible to schedule your tasks and set milestones. Thus, each week can start by reviewing the pending tasks, organize your week tasks, and at the end of the week check and mark your progress.

Issues and Labels

Let us start by setting some milestones (proposal, prototype, software function, etc.), set a Due Date, and its description. With your milestones, it will be easy to organize issues and track your progress.

After defining a milestone,

  • task
  • bug
  • improve
  • **