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.

Sign up for GitHub

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

Jump to bottom

Add CONTRIBUTING.md #21

Closed
tesla809 opened this issue Jun 4, 2021 · 12 comments · Fixed by #36
Closed

Add CONTRIBUTING.md #21

tesla809 opened this issue Jun 4, 2021 · 12 comments · Fixed by #36
Labels
good first issue Good for newcomers intermediate issues that require mid-level engineering experience

Comments

@tesla809
Copy link

tesla809 commented Jun 4, 2021 •
edited
Loading

Create a CONTRIBUTING.md file to root that covers:

  • CTA from top of README.md: give star, check out ConsenSys Academy, etc.
  • How to set up the project
  • How to setup origin and upstream
  • Brief gitflow description
  • Branching & forking strategy (main -> dev -> feat / update / fix)
  • branch naming convention
  • commit message convention
  • Add Made with ❤️ by ConsenSys
@tesla809 tesla809 changed the title CONTRIBUTING.md Add CONTRIBUTING.md Jun 4, 2021
@ConsenSys-Academy ConsenSys-Academy added good first issue Good for newcomers intermediate issues that require mid-level engineering experience labels Jun 9, 2021
@ConsenSys-Academy
Copy link
Collaborator

Good example here, IMO: https://github.com/adbar/trafilatura/blob/master/CONTRIBUTING.md

@robbiekruszynski
Copy link
Contributor

Thank you for laying this out @tesla809 going to start building this out

@ConsenSys-Academy
Copy link
Collaborator

@robbiekruszynski @tesla809 in terms of branching strategy, at this point it may make more sense to have a "features" branch, which larger changes are merged into, then we merge into main but also be able to do small one-off branch and merges with small things, like typos or adding a paragraph here and there

@tesla809
Copy link
Author

Some good resources:
https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow
https://nvie.com/posts/a-successful-git-branching-model/

@ConsenSys-Academy
Copy link
Collaborator

ConsenSys-Academy commented Jun 16, 2021 via email

@tesla809
Copy link
Author

Yup, so like 32 - 64 character for first -m message. Then 64 to 240 character for the second -m message in the commit?

@ConsenSys-Academy
Copy link
Collaborator

ConsenSys-Academy commented Jun 16, 2021 via email

@ConsenSys-Academy
Copy link
Collaborator

Just added this to #17 , but think it's applicable to anyone contributing for the first time:

Hey there! Thanks for pinging our discussion. Essentially, we want to add a "Odds and Ends" section to the first module in our course.

Here's what I'd recommend to get started, since you're new to this:

  1. Get familiar with the material: This is actually a live course you can take for free, which will walk you through the content and you can get a feel for the overall structure. Here's the course page..

  2. Get familiar with the code: The code in this repo builds a raw HTML page, which is then served up by our learning server, which builds it into a course. Each HTML page is copied from template.html, which you can see in the home directory. If you're not familiar with HTML, we recommend checking out something like this Introduction to HTML course by Mozilla.

Once you've done these things, you'll have a feel for the way both the material and the code is written and structured!

I know it seems like a lot, but you won't have to do this for every project you start, just the first few to get a feel of how different kinds of projects are structured!

Let us know if you have any questions.

@tesla809
Copy link
Author

Great point. Any suggestion on word count?

@ConsenSys-Academy
Copy link
Collaborator

@tesla809 I'd say for first-time contributors no more than a paragraph, which is about 8 to 10 sentences? Should we game out how many words on average that would be?

@ConsenSys-Academy
Copy link
Collaborator

Going through the course and found another thing:

I think there will be an "More Resources" section at the bottom of lessons, I think we should require people to say what sort of link it is (article, video, podcast, etc) with this format, optional to provide length?

Article: This is an Article Title
Video: This is a Video Title

@tesla809 tesla809 mentioned this issue Jun 21, 2021
Merged
@ConsenSys-Academy
Copy link
Collaborator

ConsenSys-Academy commented Jan 20, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers intermediate issues that require mid-level engineering experience
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added CONTRIBUTING.md tesla809/basic-training
2 participants
@tesla809 @robbiekruszynski