tchekai704
/
src-spring-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Improve Questions section in CONTRIBUTING doc 

Closes gh-27509
pull/27536/head
Brian Clozel 3 years ago
parent
ccb080f948
commit
6e92c4d674
1 changed files with 11 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 18
      CONTRIBUTING.md

18
CONTRIBUTING.md
Unescape View File

@ -6,7 +6,7 @@ First off, thank you for taking the time to contribute! :+1: :tada:
* [Code of Conduct](#code-of-conduct) * [Code of Conduct](#code-of-conduct)
* [How to Contribute](#how-to-contribute) * [How to Contribute](#how-to-contribute)
* [Discuss](#discuss) * [Ask questions](#ask-questions)
* [Create an Issue](#create-an-issue) * [Create an Issue](#create-an-issue)
* [Issue Lifecycle](#issue-lifecycle) * [Issue Lifecycle](#issue-lifecycle)
* [Submit a Pull Request](#submit-a-pull-request) * [Submit a Pull Request](#submit-a-pull-request)
@ -22,11 +22,10 @@ Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
### How to Contribute ### How to Contribute
#### Discuss #### Ask questions
If you have a question, check Stack Overflow using If you have a question, check Stack Overflow using
[this list of tags](https://stackoverflow.com/questions/tagged/spring+or+spring-mvc+or+spring-aop+or+spring-jdbc+or+spring-transactions+or+spring-annotations+or+spring-jms+or+spring-el+or+spring-test+or+spring+or+spring-remoting+or+spring-orm+or+spring-jmx+or+spring-cache+or+spring-webflux?tab=Newest). [this list of tags](https://stackoverflow.com/questions/tagged/spring+or+spring-mvc+or+spring-aop+or+spring-jdbc+or+spring-transactions+or+spring-annotations+or+spring-jms+or+spring-el+or+spring-test+or+spring+or+spring-remoting+or+spring-orm+or+spring-jmx+or+spring-cache+or+spring-webflux?tab=Newest). Find an existing discussion, or start a new one if necessary.
Find an existing discussion, or start a new one if necessary.
If you believe there is an issue, search through If you believe there is an issue, search through
[existing issues](https://github.com/spring-projects/spring-framework/issues) trying a [existing issues](https://github.com/spring-projects/spring-framework/issues) trying a
@ -39,14 +38,18 @@ decision.
Reporting an issue or making a feature request is a great way to contribute. Your feedback Reporting an issue or making a feature request is a great way to contribute. Your feedback
and the conversations that result from it provide a continuous flow of ideas. However, and the conversations that result from it provide a continuous flow of ideas. However,
before creating a ticket, please take the time to [discuss and research](#discuss) first. before creating a ticket, please take the time to [ask and research](#ask-questions) first.
If creating an issue after a discussion on Stack Overflow, please provide a description If creating an issue after a discussion on Stack Overflow, please provide a description
in the issue instead of simply referring to Stack Overflow. The issue tracker is an in the issue instead of simply referring to Stack Overflow. The issue tracker is an
important place of record for design discussions and should be self-sufficient. important place of record for design discussions and should be self-sufficient.
Once you're ready, create an issue on Once you're ready, create an issue on [GitHub](https://github.com/spring-projects/spring-framework/issues).
[GitHub](https://github.com/spring-projects/spring-framework/issues).
Many issues are caused by subtle behavior, typos and unintended configuration.
Creating a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)
(starting with https://start.spring.io for example) of the problem helps the team
triage quickly your issue adn get to the core of the problem.
#### Issue Lifecycle #### Issue Lifecycle
@ -129,3 +132,4 @@ When making changes locally, execute `./gradlew asciidoctor` and then browse the
Asciidoctor also supports live editing. For more details see Asciidoctor also supports live editing. For more details see
[AsciiDoc Tooling](https://docs.asciidoctor.org/asciidoctor/latest/tooling/). [AsciiDoc Tooling](https://docs.asciidoctor.org/asciidoctor/latest/tooling/).

Write Preview
Loading…
Cancel
Save