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

Write a contributing.md for Osmosis #891

Closed
ValarDragon opened this issue Feb 17, 2022 · 5 comments
Closed

Write a contributing.md for Osmosis #891

ValarDragon opened this issue Feb 17, 2022 · 5 comments
Assignees
Labels
C:docs Improvements or additions to documentation T:dev-UX

Comments

@ValarDragon
Copy link
Member

ValarDragon commented Feb 17, 2022

We should write a contributing.md for Osmosis that explains the branching structure, how we use the SDK fork, and how to make / test updates to SDK branches. I've recently explained it 1-1 a couple times, and folks have been left on their own to self-discover what we're doing. Would be ideal to document this.

Things to include:

  • How to update dependencies for builds: Better document our process for profiling our code #456 (comment)
  • How to change things in vendor for local builds / local testing
  • Branch structure of releases on v7, v6, v4, and using the mergify labels for backporting.
  • How to build proto files. (rm -rf vendor/ && make build-reproducible once docker is installed)
@ValarDragon ValarDragon added C:docs Improvements or additions to documentation T:dev-UX labels Feb 17, 2022
@faddat
Copy link
Member

faddat commented Mar 1, 2022

@ValarDragon why use make build-reproducible when building proto files?

I've always used make proto-gen -- is make build-reproducible preferable somehow?

@ValarDragon
Copy link
Member Author

nope it should've been make proto-all, I just typed the wrong thing haha

@jlbit
Copy link
Contributor

jlbit commented Apr 14, 2022

+1, I'm a newbie trying to contribute to osmosis (also not so familiar with golang) but hardly find any docs to website. Having really a hard time to get started. Something like https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/flinkdev/building/ should be extremely helpful

@ValarDragon any update/progress on this? Happy to partner with you and write this up as I ramp up

@xBalbinus
Copy link
Contributor

#1399 Adding this as a place to track work on this issue

@xBalbinus
Copy link
Contributor

Closing, as #1399 has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:docs Improvements or additions to documentation T:dev-UX
Projects
Archived in project
Development

No branches or pull requests

4 participants