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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Report a bug
about: Something with Osmosis is not working as expected
title: ''
labels: 'type:bug'
assignees: ''
---

#### System information

Osmosis version: `Osmosis version`
OS & Version: Windows/Linux/OSX
Commit hash:

#### Expected behaviour


#### Actual behaviour


#### Steps to reproduce the behaviour


#### Backtrace

````
[backtrace]
````

When submitting logs: please submit them as text and not screenshots.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
Copy link
Member

Choose a reason for hiding this comment

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

nit: missing new line at the end

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for creating an issue! ✰
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Background

> This is where you can provide code examples or context (e.g. past PR's)
> e.g.
> - The following PRs contributed to...

## Suggested Design

> Here, you can put concrete steps as to what to do next
> e.g.
> - create test file in...

## Acceptance Criteria

> Goals & criteria for success
> e.g.
> - all existing and new tests should pass
8 changes: 3 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Closes: #XXX

## What is the purpose of the change

*Add a description of the overall background and high level changes that this PR introduces *
> 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 Changelog

*(for example:)*

Expand Down Expand Up @@ -47,6 +47,4 @@ This change added tests and can be verified as follows:

- 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)


- How is the feature or change documented? (not applicable / specification (`x/<module>/spec/`) / [Osmosis docs repo](https://github.com/osmosis-labs/docs) / not documented)
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ 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
Expand Down