Skip to content

Commit 414c453

Browse files
author
bnasslahsen
committed
project init
0 parents  commit 414c453

File tree

6 files changed

+541
-0
lines changed

6 files changed

+541
-0
lines changed

‎.gitignore

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
######################
2+
# Project Specific
3+
######################
4+
/target/www/**
5+
/src/test/javascript/coverage/
6+
7+
######################
8+
# Node
9+
######################
10+
/node/
11+
node_tmp/
12+
node_modules/
13+
npm-debug.log.*
14+
/.awcache/*
15+
/.cache-loader/*
16+
17+
######################
18+
# SASS
19+
######################
20+
.sass-cache/
21+
22+
######################
23+
# Eclipse
24+
######################
25+
*.pydevproject
26+
.project
27+
.metadata
28+
tmp/
29+
tmp/**/*
30+
*.tmp
31+
*.bak
32+
*.swp
33+
*~.nib
34+
local.properties
35+
.classpath
36+
.settings/
37+
.loadpath
38+
.factorypath
39+
/src/main/resources/rebel.xml
40+
41+
# External tool builders
42+
.externalToolBuilders/**
43+
44+
# Locally stored "Eclipse launch configurations"
45+
*.launch
46+
47+
# CDT-specific
48+
.cproject
49+
50+
# PDT-specific
51+
.buildpath
52+
53+
######################
54+
# Intellij
55+
######################
56+
.idea/
57+
*.iml
58+
*.iws
59+
*.ipr
60+
*.ids
61+
*.orig
62+
classes/
63+
out/
64+
65+
######################
66+
# Visual Studio Code
67+
######################
68+
.vscode/
69+
70+
######################
71+
# Maven
72+
######################
73+
/log/
74+
/target/
75+
76+
######################
77+
# Gradle
78+
######################
79+
.gradle/
80+
/build/
81+
82+
######################
83+
# Package Files
84+
######################
85+
*.jar
86+
*.war
87+
*.ear
88+
*.db
89+
90+
######################
91+
# Windows
92+
######################
93+
# Windows image file caches
94+
Thumbs.db
95+
96+
# Folder config file
97+
Desktop.ini
98+
99+
######################
100+
# Mac OSX
101+
######################
102+
.DS_Store
103+
.svn
104+
105+
# Thumbnails
106+
._*
107+
108+
# Files that might appear on external disk
109+
.Spotlight-V100
110+
.Trashes
111+
112+
######################
113+
# Directories
114+
######################
115+
/bin/
116+
/deploy/
117+
118+
######################
119+
# Logs
120+
######################
121+
*.log*
122+
123+
######################
124+
# Others
125+
######################
126+
*.class
127+
*.*~
128+
*~
129+
.merge_file*
130+
131+
######################
132+
# Gradle Wrapper
133+
######################
134+
!gradle/wrapper/gradle-wrapper.jar
135+
136+
######################
137+
# Maven Wrapper
138+
######################
139+
!.mvn/wrapper/maven-wrapper.jar
140+
141+
######################
142+
# ESLint
143+
######################
144+
.eslintcache

‎CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [UnReleased] -
8+
## Added

‎CODE_OF_CONDUCT.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
= Contributor Code of Conduct
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.
7+
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.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
* The use of sexualized language or imagery
16+
* Personal attacks
17+
* Trolling or insulting/derogatory comments
18+
* Public or private harassment
19+
* Publishing other's private information, such as physical or electronic addresses,
20+
without explicit permission
21+
* Other unethical or unprofessional conduct
22+
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.
27+
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.
35+
36+
37+
This Code of Conduct is adapted from the
38+
https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at
39+
https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/] and https://github.com/spring-projects/spring-boot/blob/master/CODE_OF_CONDUCT.adoc[spring-boot Contributor Code of Conduct]

‎CONTRIBUTING.adoc

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
= Contributing to springdoc-openapi
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+
7+
8+
== 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+
12+
13+
== 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`]
17+
tag.
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.
20+
21+
If you are starting using springdoc-openapi, we advise you to use the last available release.
22+
23+
Then refer to the relevant documentation:
24+
25+
1. For OpenAPI specification 3:
26+
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
27+
2. For swagger2-annotations:
28+
- https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations
29+
3. For swagger-ui configuration:
30+
- https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md
31+
4. For springdoc-openapi:
32+
- https://springdoc.github.io/springdoc-openapi-demos/
33+
- https://springdoc.github.io/springdoc-openapi-demos/faq.html
34+
- https://springdoc.github.io/springdoc-openapi-demos/migrating-from-springfox.html
35+
36+
37+
If you are reporting a bug, please help to speed up problem diagnosis by providing as
38+
much information as possible:
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
45+
46+
47+
== 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 [email protected] and
51+
learn how to disclose them responsibly.
52+
53+
54+
== 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
61+
automatically. You can also install the
62+
https://github.com/spring-io/spring-javaformat/#intellij-idea[Spring JavaFormat IntelliJ
63+
Plugin]
64+
* 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).
71+
* Add some Javadocs.
72+
* 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+
80+
81+
== Working with the Code
82+
If you don't have an IDE preference we would recommend that you use IntellIJ.
83+
84+
=== 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+
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.
92+
93+
94+
==== 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.
97+
98+
* Download the latest https://search.maven.org/search?q=g:io.spring.javaformat%20AND%20a:spring-javaformat-intellij-plugin[IntelliJ IDEA plugin].
99+
* Select "`IntelliJ IDEA`" -> "`Preferences`".
100+
* Select "`Plugins`".
101+
* Select the wheel and "`Install Plugin from Disk...`".
102+
* Select the jar file you've downloaded.
103+
104+
105+
==== 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.
108+
109+
* Select "`IntelliJ IDEA`" -> "`Preferences`".
110+
* Select "`Editor`" -> "`Code Style`".
111+
* Select the wheel and "`Import Scheme`" -> "`IntelliJ IDEA code style XML`".
112+
* Select https://github.com/spring-projects/spring-boot/blob/master/idea/codeStyleConfig.xml[`idea/codeStyleConfig.xml`] from this repository.
113+
114+
==== Importing into Eclipse
115+
116+
You can use Spring Boot project specific source formatting settings.
117+
118+
119+
===== Install the Spring Formatter plugin
120+
* Select "`Help`" -> "`Install New Software`".
121+
* Add `https://dl.bintray.com/spring/javaformat-eclipse/` as a site.
122+
* Install "Spring Java Format".
123+
124+
NOTE: The plugin is optional. Projects can be imported without the plugins, your code
125+
changes just won't be automatically formatted.
126+
127+
=== 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.
130+
131+
The project can be built from the root directory using the standard maven command:
132+
133+
[indent=0]
134+
----
135+
$ ./mvn install
136+
----
137+
138+
139+
== 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`
142+
errors, set the `core.longPaths=true` git option:
143+
144+
```
145+
git clone -c core.longPaths=true https://github.com/springdoc/springdoc-openapi
146+
```

0 commit comments

Comments
 (0)