Skip to content

Update devGuide setting up section#1

Open
tlylt wants to merge 1 commit into
masterfrom
improve-docs
Open

Update devGuide setting up section#1
tlylt wants to merge 1 commit into
masterfrom
improve-docs

Conversation

@tlylt

@tlylt tlylt commented Jul 26, 2021

Copy link
Copy Markdown
Owner

What is the purpose of this pull request?

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

Overview of changes:
I have personally encountered a setup issue thus I think it might help others if
we include more details in the setting up guide.

Anything you'd like to highlight / discuss:

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Update devGuide setting up section

The current setup guide is rather terse.

Let's add a 'common setup issues' section to provide helpful tips and more
FAQ in the future to help with first-timers when they get the project
ready for development.

This will allow for an easier onboarding process for new developers.

I have also fixed a minor typo.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No blatantly unrelated changes
  • Pinged someone for a review!

I have personally encountered an setup issue thus I think it might help others if
we include more details in setting up guide.

The current setup guide is rather terse.

Let's add a 'common setup issues' section to provide helpful tips and more
FAQ in the future to help with first timers when they get the project
ready for development.

This will allow for easier onboarding process for new developers.

I have also fixed a minor typo.
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.

1 participant