1
# {{project_name}}
2

3
## Getting Started
4
Basic instructions for building, running, and using the project.
5

6
### Prerequisites
7
List of stack technologies
8

9
### Usage
10
Examples of running the application.
11

12
#### Environment Variables
13
List required environment variables.
14

15
## Contributing
16
See [CONTRIBUTING.md](CONTRIBUTING.md).
17

18
## Versioning
19
This project uses [Semantic Versioning](https://semver.org/).
20

21
## Authors
22
* Your Name -- [your-site.com](https://your-site.com)
23

24
## License
25
See [LICENSE.md](LICENSE.md).

1
# Security Policies and Procedures
2

3
This document outlines security procedures and general policies for the `standard`
4
project.
5

6
* [Reporting a Bug](#reporting-a-bug)
7
* [Disclosure Policy](#disclosure-policy)
8
* [Comments on this Policy](#comments-on-this-policy)
9

10
## Reporting a Bug
11

12
The `standard` team and community take all security bugs in `standard` seriously.
13
Thank you for improving the security of `standard`. We appreciate your efforts and
14
responsible disclosure and will make every effort to acknowledge your
15
contributions.
16

17
Report security bugs by emailing the lead maintainer at security@example.com.
18

19
The lead maintainer will acknowledge your email within 48 hours, and will send a
20
more detailed response within 48 hours indicating the next steps in handling
21
your report. After the initial reply to your report, the security team will
22
endeavor to keep you informed of the progress towards a fix and full
23
announcement, and may ask for additional information or guidance.
24

25
Report security bugs in third-party modules to the person or team maintaining
26
the module.
27

28
## Disclosure Policy
29

30
When the security team receives a security bug report, they will assign it to a
31
primary handler. This person will coordinate the fix and release process,
32
involving the following steps:
33

34
* Confirm the problem and determine the affected versions.
35
* Audit code to find any potential similar problems.
36
* Prepare fixes for all releases still under maintenance. These fixes will be
37
  released as fast as possible to Maven Central.
38

39
## Comments on this Policy
40

41
If you have suggestions on how this process could be improved please submit a
42
pull request.

1
# Contributing
2

3
[fork]: https://github.com/ORG/REPO/fork
4
[pr]: https://github.com/ORG/REPO/compare
5

6
When contributing to this repository, please first discuss the change you wish to make via issue,
7
email, or any other method with the owners of this repository before making a change.
8

9
Please note we have a code of conduct, please follow it in all your interactions with the project.
10

11
## Pull Request Process
12

13
1. Check the issues or open a new one
14
2. Fork this repository
15
3. Create your feature branch: `git checkout -b feature/my-new-feature`
16
4. Commit your changes: `git commit -am 'Add some feature'`
17
5. Push to the branch: `git push origin feature/my-new-feature`
18
6. Submit a pull request linked to the issue
19

20
## Our Pledge
21

22
We pledge to make our community welcoming, safe, and equitable for all.
23

24
We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
25

26

27
## Encouraged Behaviors
28

29
While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
30

31
With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
32

33
1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
34
2. Engaging **kindly and honestly** with others.
35
3. Respecting **different viewpoints** and experiences.
36
4. **Taking responsibility** for our actions and contributions.
37
5. Gracefully giving and accepting **constructive feedback**.
38
6. Committing to **repairing harm** when it occurs.
39
7. Behaving in other ways that promote and sustain the **well-being of our community**.
40

41

42
## Restricted Behaviors
43

44
We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
45

46
1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
47
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
48
3. **Stereotyping or discrimination.** Characterizing anyone's personality or behavior on the basis of immutable identities or traits.
49
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
50
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
51
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
52
7. Behaving in other ways that **threaten the well-being** of our community.
53

54
### Other Restrictions
55

56
1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
57
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
58
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
59
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
60

61

62
## Reporting an Issue
63

64
Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
65

66
When an incident does occur, it is important to report it promptly. To report a possible violation, **[NOTE: describe your means of reporting here.]**
67

68
Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
69

70

71
## Addressing and Repairing Harm
72

73
**[NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.]**
74

75
If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
76

77
1) Warning
78
   1) Event: A violation involving a single incident or series of incidents.
79
   2) Consequence: A private, written warning from the Community Moderators.
80
   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
81
2) Temporarily Limited Activities
82
   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
83
   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
84
   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
85
3) Temporary Suspension
86
   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
87
   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
88
   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
89
4) Permanent Ban
90
   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
91
   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
92
   3) Repair: There is no possible repair in cases of this severity.
93

94
This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
95

96

97
## Scope
98

99
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
100

101

102
## Attribution
103

104
This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
105

106
Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
107

108
For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla's code of conduct team](https://github.com/mozilla/inclusion).

1
The MIT License (MIT)
2
=====================
3

4
Copyright (c) {{YEAR}} {{ORG}}
5

6
Permission is hereby granted, free of charge, to any person
7
obtaining a copy of this software and associated documentation
8
files (the "Software"), to deal in the Software without
9
restriction, including without limitation the rights to use,
10
copy, modify, merge, publish, distribute, sublicense, and/or sell
11
copies of the Software, and to permit persons to whom the
12
Software is furnished to do so, subject to the following
13
conditions:
14

15
The above copyright notice and this permission notice shall be
16
included in all copies or substantial portions of the Software.
17

18
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25
OTHER DEALINGS IN THE SOFTWARE.

1
# Changelog
2

3
All notable changes to this project will be documented here.
4

5
## [Unreleased]
6
- Pending changes
7

8
## [1.0.0] - YYYY-MM-DD
9
### Added
10
- Initial release

1
# Support
2

3
## Self-help
4
- Check README.md and CHANGELOG.md
5
- Search GitHub Issues
6

7
## Community
8
- Open a GitHub Issue for bugs/features
9

10
## Commercial
11
- Email: {{SUPPORT_EMAIL}}

1
# Compiled class files
2
*.class
3

4
# Log files
5
*.log
6

7
# Package files
8
*.jar
9
*.war
10
*.nar
11
*.ear
12
*.zip
13
*.tar.gz
14
*.rar
15

16
# Gradle
17
.gradle/
18
build/
19
!gradle/wrapper/gradle-wrapper.jar
20

21
# IntelliJ IDEA
22
.idea/
23
*.iws
24
*.iml
25
*.ipr
26
out/
27

28
# VS Code
29
.vscode/
30

31
# Eclipse
32
.classpath
33
.project
34
.settings/
35

36
# macOS
37
.DS_Store
38

39
# Spring Boot
40
application-local.yml
41
application-local.properties
42

43
# Environment files
44
.env
45
.env.*
46
!.env.example
47

48
# Kotlin
49
*.kotlin_module
50

51
# Test results
52
test-output/
53

54
# SonarQube
55
.scannerwork/
56

57
# Coverage
58
jacoco/
59
coverage/