You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.adoc
+7-21Lines changed: 7 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,24 @@
1
1
= Contributor Code of Conduct
2
2
3
-
As contributors and maintainers of this project, and in the interest of fostering an open
4
-
and welcoming community, we pledge to respect all people who contribute through reporting
5
-
issues, posting feature requests, updating documentation, submitting pull requests or
6
-
patches, and other activities.
3
+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
7
4
8
-
We are committed to making participation in this project a harassment-free experience for
9
-
everyone, regardless of level of experience, gender, gender identity and expression,
10
-
sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
11
-
religion, or nationality.
5
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
12
6
13
7
Examples of unacceptable behavior by participants include:
14
8
15
9
* The use of sexualized language or imagery
16
10
* Personal attacks
17
11
* Trolling or insulting/derogatory comments
18
12
* Public or private harassment
19
-
* Publishing other's private information, such as physical or electronic addresses,
20
-
without explicit permission
13
+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
21
14
* Other unethical or unprofessional conduct
22
15
23
-
Project maintainers have the right and responsibility to remove, edit, or reject comments,
24
-
commits, code, wiki edits, issues, and other contributions that are not aligned to this
25
-
Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors
26
-
that they deem inappropriate, threatening, offensive, or harmful.
16
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
27
17
28
-
By adopting this Code of Conduct, project maintainers commit themselves to fairly and
29
-
consistently applying these principles to every aspect of managing this project. Project
30
-
maintainers who do not follow or enforce the Code of Conduct may be permanently removed
31
-
from the project team.
32
-
33
-
This Code of Conduct applies both within project spaces and in public spaces when an
34
-
individual is representing the project or its community.
18
+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project.
19
+
Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
35
20
21
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
36
22
37
23
This Code of Conduct is adapted from the
38
24
https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at
Copy file name to clipboardExpand all lines: CONTRIBUTING.adoc
+59-69Lines changed: 59 additions & 69 deletions
Original file line number
Diff line number
Diff line change
@@ -1,110 +1,100 @@
1
1
= Contributing to springdoc-openapi
2
2
3
-
springdoc-openapi is released under the Apache 2.0 license. If you would like to contribute
4
-
something, or simply want to hack on the code this document should help you get started.
5
-
6
-
3
+
springdoc-openapi is released under the Apache 2.0 license.
4
+
If you would like to contribute something, or simply want to hack on the code this document should help you get started.
7
5
8
6
== Code of Conduct
9
-
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of
10
-
conduct]. By participating, you are expected to uphold this code.
11
7
8
+
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of
9
+
conduct].
10
+
By participating, you are expected to uphold this code.
12
11
13
12
== Using GitHub Issues
14
-
We use GitHub issues to track bugs and enhancements. If you have a general usage question
15
-
please ask on https://stackoverflow.com[Stack Overflow]. The springdoc-openapi team and the
16
-
broader community monitor the https://stackoverflow.com/tags/springdoc[`springdoc`]
13
+
14
+
We use GitHub issues to track bugs and enhancements.
15
+
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
16
+
The springdoc-openapi team and the broader community monitor the https://stackoverflow.com/tags/springdoc[`springdoc`]
17
17
tag.
18
18
19
-
These are some basic guidelines before opening an issue. First of all you need to make sure, you don't create duplicate issues, and there no question already answred on https://stackoverflow.com/tags/springdoc.
19
+
These are some basic guidelines before opening an issue.
20
+
First of all you need to make sure, you don't create duplicate issues, and there no question already answred on https://stackoverflow.com/tags/springdoc.
20
21
21
22
If you are starting using springdoc-openapi, we advise you to use the last available release.
If you are reporting a bug, please help to speed up problem diagnosis by providing as
38
-
much information as possible:
39
37
40
-
- You need to describe your context (the title of an issue is not enough)
41
-
- What version of spring-boot you are using?
42
-
- What modules and versions of springdoc-openapi are you using?
43
-
- What are the actual and the expected result using OpenAPI Description (yml or json)?
44
-
- Provide with a sample code (HelloController) or Test that reproduces the problem
38
+
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible:
45
39
40
+
- You need to describe your context (the title of an issue is not enough)
41
+
- What version of spring-boot you are using?
42
+
- What modules and versions of springdoc-openapi are you using?
43
+
- What are the actual and the expected result using OpenAPI Description (yml or json)?
44
+
- Provide with a sample code (HelloController) or Test that reproduces the problem
46
45
47
46
== Reporting Security Vulnerabilities
48
-
If you think you have found a security vulnerability in Spring Boot please *DO NOT*
49
-
disclose it publicly until we've had a chance to fix it. Please don't report security
50
-
vulnerabilities using GitHub issues, instead head over to support@springdoc.org and
51
-
learn how to disclose them responsibly.
52
47
48
+
If you think you have found a security vulnerability in Spring Boot please *DO NOT*
49
+
disclose it publicly until we've had a chance to fix it.
50
+
Please don't report security vulnerabilities using GitHub issues, instead head over to support@springdoc.org and learn how to disclose them responsibly.
53
51
54
52
== Code Conventions and Housekeeping
55
-
None of these is essential for a pull request, but they will all help. They can also be
56
-
added after the original pull request but before a merge.
57
-
58
-
* We use the https://github.com/spring-io/spring-javaformat/[Spring JavaFormat] project
59
-
to apply code formatting conventions. If you use Eclipse and you follow the '`Importing
60
-
into eclipse`' instructions below you should get project specific formatting
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
65
-
`@author` tag identifying you, and preferably at least a paragraph on what the class is
66
-
for.
67
-
* Add the ASF license header comment to all new `.java` files (copy from existing files
68
-
in the project)
69
-
* Add yourself as an `@author` to the `.java` files that you modify substantially (more
70
-
than cosmetic changes).
63
+
`@author` tag identifying you, and preferably at least a paragraph on what the class is for.
64
+
* Add the ASF license header comment to all new `.java` files (copy from existing files in the project)
65
+
* Add yourself as an `@author` to the `.java` files that you modify substantially (more than cosmetic changes).
71
66
* Add some Javadocs.
72
67
* A few unit tests would help a lot as well -- someone has to do it.
73
-
* If no-one else is using your branch, please rebase it against the current master (or
74
-
other target branch in the main project).
75
-
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
76
-
if you are fixing an existing issue please add `Fixes #XXXX` at the end of the commit
77
-
message (where `XXXX` is the issue number).
78
-
79
-
68
+
* If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
69
+
* When writing a commit message please follow https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes #XXXX` at the end of the commit message (where `XXXX` is the issue number).
80
70
81
71
== Working with the Code
72
+
82
73
If you don't have an IDE preference we would recommend that you use IntellIJ.
83
74
84
75
=== Importing into IntelliJ IDEA
85
-
If you have performed a checkout of this repository already, use "`File`" -> "`Open`" and
86
-
then select the root `build.gradle` file to import the code.
87
76
88
-
Alternatively, you can let IntellIJ IDEA checkout the code for you. Use "`File`" ->
89
-
"`New`" -> "`Project from Version Control`" and
90
-
`https://github.com/spring-projects/spring-boot` for the URL. Once the checkout has
91
-
completed, a pop-up will suggest to open the project.
77
+
If you have performed a checkout of this repository already, use "`File`" -> "`Open`" and then select the root `build.gradle` file to import the code.
92
78
79
+
Alternatively, you can let IntellIJ IDEA checkout the code for you.
80
+
Use "`File`" ->
81
+
"`New`" -> "`Project from Version Control`" and
82
+
`https://github.com/spring-projects/spring-boot` for the URL.
83
+
Once the checkout has completed, a pop-up will suggest to open the project.
93
84
94
85
==== Install the Spring Formatter plugin
95
-
If you haven't done so, install the formatter plugin so that proper formatting rules are
96
-
applied automatically when you reformat code in the IDE.
86
+
87
+
If you haven't done so, install the formatter plugin so that proper formatting rules are applied automatically when you reformat code in the IDE.
97
88
98
89
* Download the latest https://search.maven.org/search?q=g:io.spring.javaformat%20AND%20a:spring-javaformat-intellij-plugin[IntelliJ IDEA plugin].
99
90
* Select "`IntelliJ IDEA`" -> "`Preferences`".
100
91
* Select "`Plugins`".
101
92
* Select the wheel and "`Install Plugin from Disk...`".
102
93
* Select the jar file you've downloaded.
103
94
104
-
105
95
==== Import additional code style
106
-
The formatter does not cover all rules (such as order of imports) and an additional file
107
-
needs to be added.
96
+
97
+
The formatter does not cover all rules (such as order of imports) and an additional file needs to be added.
108
98
109
99
* Select "`IntelliJ IDEA`" -> "`Preferences`".
110
100
* Select "`Editor`" -> "`Code Style`".
@@ -115,18 +105,18 @@ needs to be added.
115
105
116
106
You can use Spring Boot project specific source formatting settings.
117
107
118
-
119
108
===== Install the Spring Formatter plugin
109
+
120
110
* Select "`Help`" -> "`Install New Software`".
121
111
* Add `https://repo.spring.io/javaformat-eclipse-update-site/` as a site.
122
112
* Install "Spring Java Format".
123
113
124
-
NOTE: The plugin is optional. Projects can be imported without the plugins, your code
125
-
changes just won't be automatically formatted.
114
+
NOTE: The plugin is optional.
115
+
Projects can be imported without the plugins, your code changes just won't be automatically formatted.
126
116
127
117
=== Building from Source
128
-
springdoc-openapi source can be built from the command line using https://maven.apache.org/[Maven] on
129
-
JDK 1.8 or above.
118
+
119
+
springdoc-openapi source can be built from the command line using https://maven.apache.org/[Maven] on JDK 1.8 or above.
130
120
131
121
The project can be built from the root directory using the standard maven command:
132
122
@@ -135,10 +125,10 @@ The project can be built from the root directory using the standard maven comman
135
125
$ ./mvn install
136
126
----
137
127
138
-
139
128
== Cloning the git repository on Windows
140
-
Some files in the git repository may exceed the Windows maximum file path (260
141
-
characters), depending on where you clone the repository. If you get `Filename too long`
129
+
130
+
Some files in the git repository may exceed the Windows maximum file path (260 characters), depending on where you clone the repository.
0 commit comments