Skip to content
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

Feature dev community contribution guides #37

Conversation

CryptoTotalWar
Copy link
Contributor

@CryptoTotalWar CryptoTotalWar commented Mar 7, 2024

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.

  1. 1 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.
    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
  3. I created an empty MD file called "contribution-guidelines-and-standards" where i expect we would have a blurb outlining our expectations of devs who want to contribute, the workflow standards, naming conventions, etc.

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.
  • 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
  • 3. I created an empty MD file called "contribution-guidelines-and-standards" where i expect we would have a blurb outlining our expectations of devs who want to contribute, the workflow standards, naming conventions, etc.
  • standard convention for commit messages in the OSS workflow of this repo. Context

Final checklist

  • Domain specific tests
  • Full tests
  • Updated inline-comment documentation
  • Lint fixed
  • Squash and rebased
  • Sanity check the final build

@CMCDragonkai
Copy link
Member

Since this is based off the other PR, best to target that PR branch.

Also we use conventional commits as our commit messages https://www.conventionalcommits.org/en/v1.0.0/

@CMCDragonkai
Copy link
Member

Screenshot_2024-03-07-15-42-47-40_40deb401b9ffe8e1df2f1cc5ba480b12

@CryptoTotalWar
Copy link
Contributor Author

CryptoTotalWar commented Mar 7, 2024

  1. I forgot to switch the default branch for the PR (in gh) to target the PR branch I cloned off of. Will change.

  2. I'll reference https://www.conventionalcommits.org/en/v1.0.0/ for context next time making commit messages. 
    added this link as context for when doing task number 3 of this ticket (on hold at the moment) as well as I expect we will want to start accumulating a guideline of standards and conventions for other contributors in the OSS community to follow once they do come. Need to figure out the best way to break up the documentation/file formatting for the public repo so that resources and knowledge is interconnected and easy to find.

@CryptoTotalWar CryptoTotalWar changed the base branch from master to feature-launch-revamp March 7, 2024 21:48
@CryptoTotalWar
Copy link
Contributor Author

target branch for PR changed.

@CMCDragonkai
Copy link
Member

I think it's best to put everything into #33 for now since you're taking over it rather than 2 PRs. So I'm closing this, and migrating your current WIP over there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants