BUPT / magic-mirror

Magic Mirror - 魔镜
https://docs.google.com/presentation/d/12I5k_lhlEyipIdHq270JzEFA8WH5B4VPZKnmjj1YHJs/edit?usp=sharing
Apache License 2.0
17 stars 8 forks source link

Task System Initialization #2

Closed CyFeng16 closed 5 years ago

CyFeng16 commented 5 years ago

Initialization of task system, includes a markdown file and a PDF format mind-mapping.

huan commented 5 years ago

Hi @CyFeng16,

Thank you very much for taking the responsibilities of the Task System!

This PR is good, however, it needs to be changed to follow the following rules to make the repository clear and simply:

  1. Keep lowercase for all the filename & directory names(Do not use any UPPERCASE, i.e. TaskSystem -> task-system), and to be consistent, we should always use - instead of _ in the filename(exactly as in your PR)
  2. Use markdown text to describe diagrams when possible. Please do not use PDF or PNG when we can describe it as an outline, which is the most cases.

Please let me know when you finish the changes, thanks.

CyFeng16 commented 5 years ago

Well, my apology. I will follow the rules and reopen a new pull request. Thx.

huan commented 5 years ago

@CyFeng16 no problem, just suggestions and we will follow the simple rules in the future.

BTW: You can update your PR (branch from your cloned repo), instead of closed it. I'd like to suggest that you keep this PR to be open and update it, you will see how it works then. :)

CyFeng16 commented 5 years ago

Sure, I will try! The mind-mapping loses its resolution when it was added into markdown file. I'd like to try again.

CyFeng16 commented 5 years ago

I just put the a-bit-low-resolution 'png' format picture in the README.md and leave it alone. Now the pull request is ready to double check, extremely grateful.

huan commented 5 years ago

No, please do not put png files in the readme.

Instead, I'd like to suggest you just put plain text in the readme, to make it simple and clear.

Please just put text in readme this time, and if you have any question, let's discuss it in person next time.

CyFeng16 commented 5 years ago

Well, I write a markdown in text about the mind map.

huan commented 5 years ago

Thanks!