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

update github issue templates #2339

Merged
merged 1 commit into from Nov 15, 2019
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

update github issue templates

  • Loading branch information
MonsieurNicolas committed Nov 11, 2019
commit e7870a68cb41c54947979e5cca87ede625a72156
@@ -7,32 +7,32 @@ assignees: ''

---

## Before Creating an Issue
## Read before creating an issue

### Hey, I have a question!
In general, we close any issues that are
* unactionable (fill the template below under "Description")
* questions best served elsewhere

Fantastic! However, the stellar-core issues repository is meant for reporting bugs and feature
requests related to stellar-core's implementation — if you have a question, we would recommend that
you:
We have a small community of people that manages issues, and we want to ensure that the issues that remain open are high quality (so we actually get around to implementing them!).

* Take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation
related to Stellar.
* If you can't find an answer to your question, please submit a question to [Stellar's Stack
Exchange][2].
* If your question is non-developer centric, take a look at [Stellar's Community][3].
### I have a question!

In general, we close any issues that are questions best served elsewhere — we have a small
community of people that manages issues, and we want to ensure that the issues that remain open are
high quality (so we actually get around to implementing them!)
The stellar-core issues repository is meant for reporting bugs and feature requests related to stellar-core's implementation.

If you have a question, we would recommend that you take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation related to Stellar.

If you can't find an answer to your question you can:
* submit a question to [Stellar's Stack Exchange][2].
* or ask one of [Stellar's communities][3].

[1]: https://www.stellar.org/developers/
[2]: https://stellar.stackexchange.com/
[3]: https://www.stellar.org/community
[3]: https://www.stellar.org/community/#communities

### I'm fairly certain it's a bug.

* Please check existing and closed issues in Github! You may have to remove the `is:open` filter.
* Check the releases page to see if your issue has been fixed in a later release.
* Check the [releases](https://github.com/stellar/stellar-core/releases) page to see if your issue has been fixed in a later release.
* When possible, re-open an old issue if there's been a regression. Be sure to include additional
details on what was supposed to be working.

@@ -53,19 +53,17 @@ high quality (so we actually get around to implementing them!)

### stellar-core Version
* If using a standard release, please add the version returned by `./stellar-core --version`
* If working off of master, please add the git hash of the version you're running using `git
rev-parse HEAD`
* If working off of master, please add the git hash of the version you're running using `git rev-parse HEAD`

### Environment
* Operation System & Version (You can usually obtain from `uname -a`):
* Operation System & Version (You can usually obtain from `uname -a`)
* Are you running from the command line? From a container?
* Did you pass in special parameters when building the app?
* Please add any additional relevant configuration related to this bug report.

## Supporting Files

If you have any supporting files, please paste them or link to a relevant Github gist or archive
link (such as an S3 bucket).
If you have any supporting files, please paste them or link to a relevant Github gist or archive link (such as an S3 bucket).

Potential items to attach:
* Configuration files (**DON'T FORGET TO REMOVE SECRETS**)
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: General question for the community
url: https://www.stellar.org/community/#communities
about: Please ask and answer questions here.
- name: Protocol requests
url: https://github.com/stellar/stellar-protocol
about: If you have suggestions for changes to the core protocol (new operation for example) or ecosystem standards.
- name: Security bug bounty program
url: https://www.stellar.org/community/bug-bounty-program/
about: Please report security vulnerabilities here.
@@ -3,31 +3,31 @@ name: Documentation
about: Create a report for fixing or adding additional documentation related to stellar-core
title: "[Short Description] (Version: [stellar-core version])"
labels: docs
assignees: theaeolianmachine
assignees: ''

---

## Before Creating an Issue
## Read before creating an issue

### Hey, I have a question!
In general, we close any issues that are
* unactionable (fill the template below under "Description")
* questions best served elsewhere

Fantastic! However, the stellar-core issues repository is meant for reporting bugs and feature
requests related to stellar-core's implementation — if you have a question, we would recommend that
you:
We have a small community of people that manages issues, and we want to ensure that the issues that remain open are high quality (so we actually get around to implementing them!).

* Take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation
related to Stellar.
* If you can't find an answer to your question, please submit a question to [Stellar's Stack
Exchange][2].
* If your question is non-developer centric, take a look at [Stellar's Community][3].
### I have a question!

In general, we close any issues that are questions best served elsewhere — we have a small
community of people that manages issues, and we want to ensure that the issues that remain open are
high quality (so we actually get around to implementing them!)
The stellar-core issues repository is meant for reporting bugs and feature requests related to stellar-core's implementation.

If you have a question, we would recommend that you take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation related to Stellar.

If you can't find an answer to your question you can:
* submit a question to [Stellar's Stack Exchange][2].
* or ask one of [Stellar's communities][3].

[1]: https://www.stellar.org/developers/
[2]: https://stellar.stackexchange.com/
[3]: https://www.stellar.org/community
[3]: https://www.stellar.org/community/#communities

### I'd like to report a bug or feature request related to the documentation!

@@ -37,10 +37,6 @@ First, consider that Stellar's documentation is spread across multiple repositor

## Description

### What type of documentation change are you looking to report?
* `stellar-core` Docs Bug
* `stellar-core` Docs Feature Request

### Explain in detail the incorrect or additional documentation you'd like to see.

*Be descriptive, including any suggestions you may have with regard to the layout and content of our docs*.
@@ -7,41 +7,40 @@ assignees: ''

---

## Before Creating an Issue
## Read before creating an issue

### Hey, I have a question!
In general, we close any issues that are
* unactionable (fill the template below under "Description")
* questions best served elsewhere

Fantastic! However, the stellar-core issues repository is meant for reporting bugs and feature
requests related to stellar-core's implementation — if you have a question, we would recommend that
you:
We have a small community of people that manages issues, and we want to ensure that the issues that remain open are high quality (so we actually get around to implementing them!).

* Take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation
related to Stellar.
* If you can't find an answer to your question, please submit a question to [Stellar's Stack
Exchange][2].
* If your question is non-developer centric, take a look at [Stellar's Community][3].
### I have a question!

In general, we close any issues that are questions best served elsewhere — we have a small
community of people that manages issues, and we want to ensure that the issues that remain open are
high quality (so we actually get around to implementing them!)
The stellar-core issues repository is meant for reporting bugs and feature requests related to stellar-core's implementation.

If you have a question, we would recommend that you take a look at Stellar's [developer portal][1], where you'll find comprehensive documentation related to Stellar.

If you can't find an answer to your question you can:
* submit a question to [Stellar's Stack Exchange][2].
* or ask one of [Stellar's communities][3].

[1]: https://www.stellar.org/developers/
[2]: https://stellar.stackexchange.com/
[3]: https://www.stellar.org/community
[3]: https://www.stellar.org/community/#communities

### I'd like to request new functionality in stellar-core!

First, you have to ask whether what you're trying to file is an issue related to Stellar's Protocol
OR if it's related to `stellar-core`, the C++ implementation that's in this repository.

Typically a request that changes how the core protocol works (such as adding a new operation,
changing the way transactions work, etc) is best filed in the [Stellar Protocol repository][4].
Typically a request that changes how the core protocol works (such as adding a new operation, changing the way transactions work, etc) is best filed in the [Stellar Protocol repository][4].

However, if your change is related to the implementation (say you'd like to see a new command line
flag or HTTP command added to stellar-core), this is the place.

* Please check existing and closed issues in Github! You may have to remove the `is:open` filter.
* Check the releases page to see if your request has already been added in a later release.
* Check the [releases](https://github.com/stellar/stellar-core/releases) page to see if your request has already been added in a later release.

[4]: https://github.com/stellar/stellar-protocol/issues

@@ -51,8 +50,8 @@ flag or HTTP command added to stellar-core), this is the place.
*Be descriptive, including the interface you'd like to see, as well as any suggestions you may have
with regard to its implementation.*

### Is your feature request related to a problem? Please describe.
*A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]*
### Explain why this feature is important
*If it's related to some problem you're having, give a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]*

### Describe the solution you'd like
*A clear and concise description of what you want to happen.*
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.