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

Contributing.md link & PR template simplifications & Added ISSUE_TEMPLATE.md #1399

Merged
merged 16 commits into from
May 9, 2022
Merged
17 changes: 17 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this exist under .github/ISSUE_TEMPLATE? Also, what kind of template is this? For bugs? I propose something like the following: https://github.com/umee-network/umee/blob/main/.github/ISSUE_TEMPLATE/bug-report.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't happen to know we had a .github/ISSUE_TEMPLATE already if we did (I don't happen to see it), I can definite create a /ISSUE_TEMPLATE folder though. And this was originally supposed to be for generic issues, not specifically bugs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, we should have templates per type IMO (i.e. bugs, general proposal, features, etc...). Otherwise, having a template isn't all that useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alright, I'll make that then

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think general proposals / features are done in a separate repo, and questions are done in our discord server, so I currently only implemented the bug reporter template, the generic issue template along with the option to still open blank issues. Let me know your thoughts :)

Copy link
Contributor

Choose a reason for hiding this comment

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

I think bug report and general template is fine. I don't really understand why features are done in a separate repo, but I don't wanna bike shed here.

v ✰ Thanks for creating an issue! ✰
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Background
*this is where you can provide code examples or context (e.g. past PR's)*
*(for example)*
- *The following PRs contributed to...*

## Suggested Design
*here, you can put concrete steps as to what to do next*
*(for example)*
- *create test file in...*
## Acceptance Criteria
*goals & criteria for success*
*(for example)*
- *all existing and new tests should pass*
50 changes: 8 additions & 42 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,18 @@
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for creating a PR! ✰
v Before smashing the submit button please review the checkboxes.
v If a checkbox is n/a - please still include it but + a little note why
v If your PR doesn't close an issue, that's OK! Just remove the Closes: #XXX line!
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Which issue does this close?
Closes: #XXX
## Purpose of the change
*Add a description of the overall background and high level changes that this PR introduces*
alexanderbez marked this conversation as resolved.
Show resolved Hide resolved

## What is the purpose of the change

*Add a description of the overall background and high level changes that this PR introduces *

*(E.g.: This pull request improves documation of area A by adding ....*


## Brief change log

## Brief change log (include any info relevant to tests))
Copy link
Member

Choose a reason for hiding this comment

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

what is (include any info relevant to tests) for?

alexanderbez marked this conversation as resolved.
Show resolved Hide resolved
*(for example:)*

- *The metadata is stored in the blob store on job creation time as a persistent artifact*
- *Deployments RPC transmits only the blob storage reference*
- *Daemons retrieve the RPC data from the blob cache*


## Testing and Verifying
p0mvn marked this conversation as resolved.
Show resolved Hide resolved

*(Please pick one of the following options)*

This change is a trivial rework / code cleanup without any test coverage.

*(or)*

This change is already covered by existing tests, such as *(please describe tests)*.

*(or)*

This change added tests and can be verified as follows:

*(example:)*
Copy link
Member

Choose a reason for hiding this comment

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

Do others dislike this? I thought this was great, I just choose the one I want and delete everything else

*(tests example:)*
- *Added unit test that validates ...*
- *Added integration tests for end-to-end deployment with ...*
- *Extended integration test for ...*
- *Manually verified the change by ...*

## Documentation and Release Note

- Does this pull request introduce a new feature or user-facing behavior changes? (yes / no)
- Is a relevant changelog entry added to the `Unreleased` section in `CHANGELOG.md`? (yes / no)
- How is the feature or change documented? (not applicable / specification (`x/<module>/spec/`) / [Osmosis docs repo](https://github.com/osmosis-labs/docs) / not documented)

Copy link
Member

Choose a reason for hiding this comment

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

I feel like this one was better, it forced acknowledgement of the options for docs updates

## Documentation and Release Note (for new features, delete if N/A)
- A relevant changelog entry was added to the `Unreleased` section in `CHANGELOG.md`? (yes / no)
- Documentation exists for this current feature? (yes / no)

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ For the most up to date documentation please visit [docs.osmosis.zone](https://d

Thank you for supporting a healthy blockchain network and community by running an Osmosis node!

## Contributing
xBalbinus marked this conversation as resolved.
Show resolved Hide resolved
The contributing guide for Osmosis explains the branching structure, how to use the SDK fork, and how to make / test updates to SDK branches.

For more information, please see [the contributing guide](https://docs.osmosis.zone/developing/get_started/contributing.html).

## Why Osmosis?
### On customizability of liquidity pools
Most major AMMs limit the changeable parameters of liquidity pools. For example, Uniswap only allows the creation of a two-token pool of equal ratio with the swap fee of 0.3%. The simplicity of Uniswap protocol allowed quick onboarding of the average user that previously had little to no experience in market making.
Expand Down