Feature dev community contribution guides #37
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a new guide for developers who want to contribute to the Polykey repository. It outlines the necessary setup steps for macOS, Windows, and Linux users, including the installation of development tools and the configuration of development environments.
Note: this may be redundant as we would probably expect most dev contributors to to be more high-level and either have already done these steps or do not require our documentation to help them.
Note: I left the Windows and Linux part blank because I only know the process required for Mac
Issues Fixed
None, this was a test run
Tasks
[ ] 1. One new folder called "community contributions" created and added under "development-guide"[ ] 2. 1 new file under this new folder called "contributor-setup-guide" outlining the global dev dependencies and requirements for devs to get started with cloning the repo.Final checklist