Skip to content

Improve contributing.md docs#1529

Merged
einarf merged 1 commit intopythonarcade:developmentfrom
cspotcode:improve-contributing-docs
Feb 17, 2023
Merged

Improve contributing.md docs#1529
einarf merged 1 commit intopythonarcade:developmentfrom
cspotcode:improve-contributing-docs

Conversation

@cspotcode
Copy link
Collaborator

@cspotcode cspotcode commented Feb 17, 2023

Related to #995. However, this PR does not concern itself with all of the things that may be discussed in #995. It can and should be merged if it makes a net improvement in documentation. We discussed this on Discord:
https://discord.com/channels/458662222697070613/705076586986078350/1076173114410549258

This PR focuses on one thing:
What commands should a first-time contributor run to:

a) install development dependencies
b) run automated tests
c) submit a pull request that improves arcade's code in some way

It is not concerned with installing arcade from source. That is a separate topic covered by different documentation.

Other ideas:

  • discourage using make.bat
  • explain how to rebuild the docs and preview them in a browser locally
  • explain how to setup a venv

However, if we get mired in discussion, then we should focus on merging this PR as-is and making further improvements in other PRs.

Copy link
Member

@pushfoo pushfoo left a comment

Choose a reason for hiding this comment

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

Looks ok, let's merge it.

@einarf einarf merged commit ea97855 into pythonarcade:development Feb 17, 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.

3 participants