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

Add gitcop and similar restrictions as go-ethereum #84

Closed
prestonvanloon opened this issue Mar 30, 2018 · 11 comments
Closed

Add gitcop and similar restrictions as go-ethereum #84

prestonvanloon opened this issue Mar 30, 2018 · 11 comments
Assignees
Labels
Enhancement New feature or request
Milestone

Comments

@prestonvanloon
Copy link
Member

We're already facing a huge problem with go-ethereum coding guidelines

Please make sure your contributions adhere to our coding guidelines:

Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
Code must be documented adhering to the official Go commentary guidelines.
Pull requests need to be based on and opened against the master branch.
Commit messages should be prefixed with the package(s) they modify.
E.g. "eth, rpc: make trace configs optional"

We'll need to retroactively conform to these guidelines as well, and it likely won't be very fun, but this should be done sooner rather than later.

@prestonvanloon prestonvanloon added the Enhancement New feature or request label Mar 30, 2018
@prestonvanloon prestonvanloon added this to the Diamond milestone Mar 30, 2018
@prestonvanloon prestonvanloon self-assigned this Mar 30, 2018
@rauljordan
Copy link
Contributor

The only thing we haven't really been following is the commit message structure. Let's make sure everyone on the team is on the same page.

@terencechain
Copy link
Member

terencechain commented Apr 1, 2018

Web3.py and py-evm's commit message structure:

  • What was wrong?
  • TODO
  • How was it fixed?
  • Cute Animal Picture

@terencechain
Copy link
Member

terencechain commented Apr 1, 2018

Vyper's commit message structure:

  • What I did
  • How I did it
  • How to verify it
  • Description for the changelog
  • Cute Animal Picture

@terencechain
Copy link
Member

terencechain commented Apr 1, 2018

Solidity doesn't have a commit message structure, it refers to issue

@terencechain
Copy link
Member

Casper's commit message structure:

  • Issue
  • Proposed implementation

@prestonvanloon
Copy link
Member Author

I reached out to the folks at ethereum/go-ethereum to get a copy of their gitcop configuration. I've also enabled gitcop (I think), but it might not be the same rules until I hear back.

I'll rebase all of our commit messages, but it will take a me a little while to do it since there are 3 months worth of messages that do not conform to the rule.

From now on, we must use the sharding: prefix to our commit messages.

@terencechain
Copy link
Member

terencechain commented Apr 2, 2018 via email

@prestonvanloon
Copy link
Member Author

prestonvanloon commented Apr 2, 2018

Yeah, any clue how to do this properly? I tried git rebase -i bc76d3e96886cd2e354605bec40d326477090015 and changed the commit messages in the git-todo along with setting it to "reword", but it seems to have not reworded anything and just double signed all commits. master...prestonvanloon:forced-rebase

@rauljordan
Copy link
Contributor

What do we need to get this closed? Do we just have to update all our previous commit msgs?

@prestonvanloon
Copy link
Member Author

Yeah and enable gitcop. I have the settings from Peter in an email. If you know of an easy way to update all of the previous messages, let me know!

@rauljordan
Copy link
Contributor

We will no longer be dependent on Geth. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants