Skip to content

Conversation

@aedwardg
Copy link
Collaborator

What issue is this solving?

Closes #29

Description

Add initial contribution guidelines for all contributors, as well as maintainers.

Any helpful knowledge/context for the reviewer?

  • Any new dependencies to install? ❌
  • Any special requirements to test? ❌
  • Any UI changes? Include screenshots if so. ❌

Feelings gif (optional)

What gif best describes your feeling working on this issue? https://giphy.com/
How to embed:
kermit typing

Please make sure you've attempted to meet the following coding standards

  • Code has been tested and does not produce errors
  • Code is readable and formatted
  • There isn't any unnecessary commented-out code

Copy link
Member

@ashstewart7 ashstewart7 left a comment

Choose a reason for hiding this comment

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

Awesome - just a couple tiny suggestions/things for discussion :)

- If you become a regular contributor, you may request to be added as a collaborator on the project so that you can work from a direct clone rather than a fork.
- Name your feature branch something descriptive of your task. Including the issue number is common practice.
- For example, if you are working on issue number 42 and performing a refactor on the navbar component, a good branch name would be `42-refactor-navbar-component`.
- Ensure that your code works, tests pass and your code is properly linted and formatted prior to opening a PR.
Copy link
Member

Choose a reason for hiding this comment

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

Might be worth adding that, once a PR is created and the user is happy with it, to formally request review from @\CodeCafeCommunity/website?

Copy link
Contributor

Choose a reason for hiding this comment

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

Or create a discord channel specifically for contributors. And assign a role only when someone has actively taken on an issue. I don't know if that can be done with an automatic process.

Copy link
Member

Choose a reason for hiding this comment

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

Ooh neat, I think we'd probably have to do it manually, but I agree with having a channel.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I definitely like the idea of having a dedicated channel and Contributor role in the discord server! I think maybe they should receive the role after having a PR merged in. Once we have that set up we can add a section about it to this document

@ashstewart7 ashstewart7 self-requested a review December 30, 2024 23:25
Copy link
Member

@ashstewart7 ashstewart7 left a comment

Choose a reason for hiding this comment

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

LGTM!

@aedwardg aedwardg merged commit 697518d into main Jan 7, 2025
3 checks passed
@aedwardg aedwardg deleted the 29-add-contribution-guidelines branch January 7, 2025 23:34
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.

Add additional contribution guidelines

4 participants