Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update workflow docs #1659

Merged
merged 1 commit into from
Aug 26, 2021
Merged

Update workflow docs #1659

merged 1 commit into from
Aug 26, 2021

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Aug 22, 2021

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:
Fixes #1655
Update workflow guide in developer docs to:

  • fix broken links
  • update dependency management section

Anything you'd like to highlight / discuss:
Will definitely need active/senior devs to confirm/amend if the steps described for the handling of dependencies are recommended/correct.

Testing instructions:
nil

Proposed commit message: (wrap lines at 72 characters)
Update workflow dev docs

The workflow guide contains broken links to the design section. The
instruction on how to manage dependencies is not comprehensive.

Let's fix the broken links and include more details on how to add,
update, or delete a dependency.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @tlylt :) Looks clear and detailed to me. LGTM.

@jonahtanjz jonahtanjz added this to the 3.0.7 milestone Aug 26, 2021
@jonahtanjz jonahtanjz merged commit 8c5ab8b into MarkBind:master Aug 26, 2021
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.

Steps to take when updating dependencies
2 participants