JupiterBroadcasting / jupiterbroadcasting.com

JupiterBroadcasting.com, hugo-based and community-driven!
https://jupiterbroadcasting.com
100 stars 49 forks source link

Update the CONTRIBUTING.md file #512

Open elreydetoda opened 1 year ago

elreydetoda commented 1 year ago

Feature Description

At minimum, we need to add JS docs to CONTRIBUTING.md.

Having someone new, especially who doesn't have very much technical or hugo/web-dev experience ensure that all the steps and general guidance in that doc is useful (giving some type of feedback probably on this issue or on their PR), would probably help ensure it's well documented from a new person perspective.

I'd imagine some documentation around the testing stuff would be helpful as well. @TheHesster had expressed some potential interest in this part (tests), so if you'd like to tackle that, that'd be awesome (no pressure though if you don't want to).

Reference to Feature

elreydetoda commented 1 year ago

Also, just got approval from @gerbrent to recommend including some videos that I helped create the commands/guides for and @bluelotus03 actually did a workshop with @GWC-UNCC's people.

It's actually the first 3 videos of this playlist: https://youtube.com/playlist?list=PLxG0x9l83vZcHE3oIXEpmHmPt6-hxL17y

  1. Is setting everything up & basic git stuff
  2. Some more advanced usage with Git(Hub) (mainly PRs & and stuff)
  3. Is initially using hugo
1701home commented 1 year ago

I was going to try this again, but I was thinking about adding a template for a baseline that might help others I am currently using to document a pull request. @elreydetoda @CGBassPlayer @gerbrent, any thoughts?

Pull Request Notes

Description

Give a brief overview of the pull request. What is the purpose of this pull request? What changes does it make?

Related Issues

List any related issues that this pull request is addressing. Include links to those issues.

Changes Made

Describe the changes that you made in this pull request. Be as detailed as possible. If the changes are complex, consider breaking them down into sub-sections.

Testing

Explain how the changes were tested. Provide details about the testing environment, including any test cases that were run, and the results of those tests.

Screenshots

If applicable, include screenshots of the changes made in this pull request.

Checklist

Additional Notes

Include any additional notes or comments that you think might be relevant to the pull request.

CGBassPlayer commented 1 year ago

I think some notes on what to document in a PR would be helpful. Would make reviewing the PRs slightly faster. I actually started a SUPER basic template for PRs here, but it didn't name it in a way to actually appear when creating a PR (yet?). So you may want to look into improving that in conjunction with what you are thinking for the contributing document.

But overall for this document, I want you to think about what you would have wanted to know in general about contributing to the repo. Maybe look back in the matrix chat and see what kind of questions are being asked that are not directly code related. For at least myself, there are things that I just inherently know from working on this project that I do not think about being needed in a getting started style document.