METU-KALFA / Guide

The blueprint repository for the Kovan Github
0 stars 0 forks source link

Guide Issue #1

Open burakbolat opened 3 years ago

burakbolat commented 3 years ago

Guide Issue

Issues are used to figure out new ideas, encountered errors and weekly tasks. Kovan weekly tasks are assigned and tracked through issues.

Projects

Issues are added to the projects tab. Projects tab is an easy approach to track the progress through issues. The state of the project can be extracted with projects tab instead of following each issue independently.

Todo

Tasks can be assigned as task list and progress can be automatically followed from the projects tab.

Mentions

Github free allows only one assignment for an issue. Nevertheless, mentions can be used to assign tasks to more than one colleague. Eg. @burakbolat, @ozgraslan

burakbolat commented 3 years ago

Guide Comment

This is an example comment to show to reply an assigned issue. You can add more or use less titles listed below.

Introduction

Briefly introduce your work before diving into details. Features of the work may be listed here.

Background

If necessary, explain previous studies you have done. It is nice to recap since most of the people in Kovan relates with divergent
projects.

What is done

Explain what you have done. Putting code blocks, math expression, visual material makes it stronger. You can list pros and cons here.

Errors / Installation / Usage

If your work includes some of them, you can briefly define steps. List errors to be solved or if error is solved, describe the steps.

Todo / Roadmap / Conclusion

Explain possible ways to improve your study.