Skip to content

Update contribute.md#475

Merged
JF002 merged 4 commits intoInfiniTimeOrg:developfrom
Riksu9000:update_contribute_doc
Aug 14, 2021
Merged

Update contribute.md#475
JF002 merged 4 commits intoInfiniTimeOrg:developfrom
Riksu9000:update_contribute_doc

Conversation

@Riksu9000
Copy link
Contributor

Fixed and changed some spellings in contribute.md

I noticed that there is also this file. Do we need this separate one?
https://github.com/JF002/InfiniTime/blob/develop/CONTRIBUTING.md

@JF002
Copy link
Collaborator

JF002 commented Jul 11, 2021

Do we need this separate one?

I don't think so. CONTRIBUTING.md is suggested by github as community guideline, but it's not mandatory. Personally, I prefer to put all documentation files into /doc, but github recommand CONTRIBUTING.md as community guideline.

We can either use only CONTRIBUTING.md, or link doc/contributing.md into CONTRIBUTING.md to make everyone happy.

What are your thoughts about this?

@Riksu9000
Copy link
Contributor Author

I think it should be linked. Do I make the changes here? I can add the info about autoformatting from CONTRIBUTING.md to doc/contributing.md, but I don't think there's anything else that needs to be added.

@JF002
Copy link
Collaborator

JF002 commented Jul 25, 2021

I think it should be linked. Do I make the changes here? I can add the info about autoformatting from CONTRIBUTING.md to doc/contributing.md, but I don't think there's anything else that needs to be added.

Yes, that would be nice if you could do that, thanks!

@JF002 JF002 added this to the Version 1.4 milestone Jul 25, 2021
@Riksu9000
Copy link
Contributor Author

Looks like GitHub doesn't handle symbolic links very nicely. Is there a better way to link it or do I just move it anyway?

@Avamander
Copy link
Collaborator

Avamander commented Jul 25, 2021

Looks like GitHub doesn't handle symbolic links very nicely. Is there a better way to link it or do I just move it anyway?

Git supports symbolic links, I assume that's what you commited to the repository? If so then it's fine, the UI can't necessarily resolve it but in the end it's going to be humans who will know to check the right folder, should they be using the web UI.

@JF002
Copy link
Collaborator

JF002 commented Jul 28, 2021

When I talk about linking, I was thinking about adding a link (url) in one of the file to the second one :-)
But if symbolic links work, why not!

@JF002 JF002 merged commit f0e9d13 into InfiniTimeOrg:develop Aug 14, 2021
jonvmey pushed a commit to jonvmey/InfiniTime that referenced this pull request Aug 21, 2021
* origin/develop: (37 commits)
  Add memory print usage
  Fix music app buttons
  Adjust inner padding in applist
  Clean up using variables
  Adjust previously missed scrollbar and firmware validation buttons
  Add image with example layouts
  Ui update
  Add VSCode ST-link debug config (InfiniTimeOrg#567)
  Improve metronome
  Set pin before loop
  Better pin configuration
  Try to fix bootloop
  Update contribute.md (InfiniTimeOrg#475)
  Code cleaning in Clock, WatchFaceAnalog, WatchFaceDigital and PineTimeStyle, inspired by PR InfiniTimeOrg#232 by nscooling.
  Setup plugins for Clang-tidy/format
  Fix intellisense
  Typos for days
  Updated documentation
  Added cmake variants
  added extra .sh build files
  ...
@Riksu9000 Riksu9000 deleted the update_contribute_doc branch January 21, 2023 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants