aquazx20
/
DisplayESP32
generated from gmarx/git-template
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
Display library for ESP32
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
19 KiB
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
DisplayESP32/Readme.md

47 lines
2.4 KiB
Raw Permalink Normal View History

Initial commit
1 year ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. # Readme

  2. 

  3. # Basic Instructions of Repository 

  4. 

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

  7. 

  8. ## Readme and Wiki 

  9. 

  10. 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.
  11. 

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

  14. 

  15. 

  16. ## Projects and Issues tab 

  17. 

  18. 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.
  19. 

  20. ### Issues and Labels

  21. 

  22. 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.
  23. 

  24. After defining a milestone, 
  25. 

  26. 

  27. - **task**
  28. - **bug** 
  29. - **improve**
  30. - **
  31. 

  32. The `git-template` includes 9 basic labels to use each time you create an issue. These labels are detailed next:
  33. 

  34. - bug: Somethign is not working as expected or getting wrong results 
  35. - duplicated: This issue or pull request already exists 
  36. - further work: General advices to be considered in future elements, projects or submodules 
  37. - help wanted: Some help is required by supervisors; directions, raw material, material, review results, or laboratory assistance 
  38. - improve: Something has to be improved or rebuiled to improve expected results 
  39. - question: Something needs a fast review or guidance to focus the aim of the project 
  40. - submodules: The project should considers to create a submodule element to integrate in this project
  41. - task: Assigned task to complete a milestone or project element; the assigned collaborators have to complete the task 
  42. - wiki: Elements or information to be included in the Wiki page 
  43. 

  44. ### Projects

  45. **Considers that this is the main repository. Thus, create projects for main elements (circuit stage, specific behaivior, component, document, simulation, or submodule, etc.) to manage components or submodules related with the main repository**.
  46. 

  47. In the project always create three main boards: Todo, In Progress and Done.