search

ubclaunchpad / inertia

✈️ Effortless, self-hosted continuous deployment for small teams and projects
https://inertia.ubclaunchpad.com
MIT License
153 stars 18 forks source link

docs: CONTRIBUTING.md Development Tips table of contents has strange scope #714

Open AmirNaghibi opened 4 years ago

AmirNaghibi commented 4 years ago

Describe the issue A clear and concise description of what the issue is.

Development Tips section in CONTRIBUTING.md comes after Guidelines section but it includes a table of contents starting with the Guideline section.

Additional context Add any other context about the problem here, such as screenshots and links to relevant documentation.

Development Tips section should move above the Guideline Section

Screen Shot 2020-10-29 at 2 20 59 AM
bobheadxi commented 4 years ago

Quoting from https://github.com/ubclaunchpad/inertia/pull/715#issuecomment-718705003 :

I'm not sure this change makes much sense, since the guidelines section is for pull requests and not development - the development guide is separate because it is what you would consult once you're already familiar with the guidelines. There is already a link to skip to the development section so it's not like it's hard to find anything.

bobheadxi commented 4 years ago

If anything, the fix should be to adjust the table of contents to just encapsulate the development section