Skip to content

Commit

Permalink
Rework issue templates, align with kupo.
Browse files Browse the repository at this point in the history
  This leans towards using github discussions more; because they are in the end more suited for 'casual chats' and debating on features. Once ready, discussions can be turned into proper issues.
  • Loading branch information
KtorZ committed Jan 25, 2023
1 parent 02b68ce commit 5862b90
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 47 deletions.
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/bug.md
@@ -1,18 +1,14 @@
---
name: bug
about: Create a bug report

---

#### What Git revision are you using?
### What Git revision / release tag are you using?

#### What operating system are you using, and which version?
### Do you use any client SDK? If yes, which one?

- [ ] Linux / Ubuntu
- [ ] Linux / Other
- [ ] OSX
- [ ] Windows
### Describe what the problem is?

#### Describe what the problem is?
### What should be the expected behavior?

#### What should be the expected behavior?
### If applicable, what are the logs from the server around the occurence of the problem?
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/idea.md
@@ -1,11 +1,10 @@
---
name: idea
about: Propose a new idea

about: Propose a new idea or request a feature.
---

#### Describe your idea, in simple words.
### What is your idea? Provide a use case.

#### Why is it a good idea?
### Why is it a good idea?

#### Are you willing to work on it yourself?
### What is the current alternative and why is it not good enough?
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/project.md

This file was deleted.

5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

33 changes: 20 additions & 13 deletions CONTRIBUTING.md
Expand Up @@ -2,40 +2,47 @@

## What & How Can You Contribute?

1. **Feedback**
#### 1. Feedback

Contributions in the form of feedback and issue is very much welcome. Might it be a suggestion, a bug report or maybe some questions that you have. It helps improving Ogmios in the long run and these are probably the best kind of contributions to start with.
Contributions in the form of feedback and issue is very much welcome. Might it be a suggestion, a bug report or maybe some questions that you have. It helps improving Ogmios in the long run and these are probably the best kind of contributions to start with. See [About Issues/Discussions](#about-issues--discussion) below for guidelines.

Do not hesitate to add _thumbs up :+1:_ on open issues you support to show your interest.
Do not hesitate to upvote discussions or comments to show your interest!

2. **Code**
#### 2. Code

Refer to the [building](https://ogmios.dev/getting-started/building/) and [testing](https://ogmios.dev/getting-started/testing/) sections of the [user-manual](https://ogmios.dev) if you're willing to hack a bit on Ogmios. The project follows a quite strict architecture as detailed in the [server's README](https://github.com/CardanoSolutions/ogmios/tree/master/server#architecture).
Refer to the [building](https://ogmios.dev/getting-started/building/) and [testing](https://ogmios.dev/getting-started/testing/) sections of the [user-manual](https://ogmios.dev) if you're willing to hack a bit on Ogmios. The project follows a quite strict architecture as detailed in the [server's README](https://github.com/CardanoSolutions/ogmios/tree/master/server#architecture).

Past (and future) design decisions have been (will be) recorded as [Architectural Decision Records](https://github.com/CardanoSolutions/ogmios/tree/master/architectural-decisions/accepted). Have a look at them before you start hacking to better understand some of trade-offs made during the development.
Past (and future) design decisions have been (will be) recorded as [Architectural Decision Records](https://github.com/CardanoSolutions/ogmios/tree/master/architectural-decisions/accepted). Have a look at them before you start hacking to better understand some of trade-offs made during the development.

Coding standards are enforced using tools and configuration defined in the repository. Make sure to configure your editor to pick them up.
Coding standards are enforced using tools and configuration defined in the repository. Make sure to configure your editor to pick them up.

Pull requests are welcome, but we do recommend to open an issue to bring any idea to discussion first!
Pull requests are welcome, but we do recommend to open an issue to bring any idea to discussion first!

3. **Donation**
#### 3. Donation

Want to give some financial support? Have a look at the [sponsors page](https://github.com/sponsors/KtorZ/) for more details.
Want to give some financial support? Have a look at the [sponsors page](https://github.com/sponsors/KtorZ/) for more details.

## About Issues

### :bug: How To Report A Bug

Open a [Bug Issue](https://github.com/cardanosolutions/ogmios/issues/new?template=bug.md).
Open a [Bug Issue](https://github.com/cardanosolutions/ogmios/issues/new?template=bug.md).

### :bulb: How To Propose An Idea

Open a [Proposal Issue](https://github.com/cardanosolutions/ogmios/issues/new?template=idea.md).
Feel free to bring it as a [discussion [category: idea]](https://github.com/CardanoSolutions/kupo/discussions/new?category=ideas). Make sure to highlight your use case so we can understand the design space and agree on a solution.

> **Note** Ideally, follow this simple template:
>
> - What is your idea? Describe it in simple words. Provide a use case.
> - Why is it a good idea?
> - What is the current alternative and why is it not good enough?
### :question: How To Ask a Question

Open a [Q&A Discussion](https://github.com/CardanoSolutions/ogmios/discussions/new?category=q-a).
Open a [Q&A Discussion](https://github.com/CardanoSolutions/ogmios/discussions/new?category=q-a).

> **Warning**
> Make sure to mark your question as _Answered_ once resolved!
## Need Help Getting Started?
Expand Down

0 comments on commit 5862b90

Please sign in to comment.