Skip to content

Add Contributing Guide index page #1773

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

Merged
merged 3 commits into from
May 18, 2023

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented May 15, 2023

Changes

  • Add a contributing guide index page with a stubbed toctree to include future children
  • Link the new page from the quick index
  • Change the home page's Source Code heading to Source Code & Contributing

Why

This is a first step to the following:

  1. Centralizing contributor / developer install instructions
  2. Adding more detailed documentation covering our style conventions, unit tests, build system, etc
  3. Adding short guides & links to general how-to pages for common development tasks & tools (ie adding remotes to check out & test other people's PRs)

How to Test

  1. Check out the branch locally
  2. ./make.py serve
  3. Open http://localhost:8000 in your browser
  4. Make sure the index page has been linked on the home page
  5. Click the Contributing Guide index link to make sure it works
  6. Make sure the content of the page looks ok
  7. Click the CONTRIBUTING.md link to make sure it redirects users to GitHub for the quickstart.

@pvcraven pvcraven merged commit 501ef3f into pythonarcade:development May 18, 2023
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.

2 participants