Skip to content

Commit e65e1f5

Browse files
committed
Add contributing guidelines, code of conduct, security policy, and support documentation
1 parent a7d60cc commit e65e1f5

5 files changed

Lines changed: 178 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <opensource@github.com>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Thanks for your interest in improving this project.
4+
5+
## Prerequisites
6+
7+
- Java 25
8+
- Maven 3.9+
9+
- VS Code (recommended)
10+
11+
## Local development
12+
13+
1. Compile the app:
14+
15+
```bash
16+
mvn compile -f sample-app/pom.xml
17+
```
18+
19+
2. Run the app:
20+
21+
```bash
22+
java --module-path sample-app/target/classes --module com.example.app/com.example.app.Application
23+
```
24+
25+
3. Open http://localhost:8080
26+
27+
## Project conventions
28+
29+
- Keep the code framework-agnostic (no Spring or other web frameworks).
30+
- Use Java module system (`module-info.java`) patterns already in the project.
31+
- Prefer small, focused classes and methods.
32+
- Keep frontend changes in `sample-app/src/main/resources/static/`.
33+
34+
## Pull requests
35+
36+
- Use a clear title and description explaining the problem and solution.
37+
- Keep PRs scoped to one concern when possible.
38+
- Update documentation (`README.md`, this file) when behavior or commands change.
39+
- Ensure the project builds before submitting:
40+
41+
```bash
42+
mvn verify -f sample-app/pom.xml
43+
```
44+
45+
## Code of conduct
46+
47+
Please be respectful and constructive in discussions and reviews.
48+
49+
## License
50+
51+
By contributing, you agree that your contributions will be licensed under the MIT License in this repository.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,7 @@ sample-app/
5555
- JDK `HttpServer` (`jdk.httpserver` module)
5656
- Vanilla JavaScript + Bootstrap 5
5757
- Apache Maven
58+
59+
## Contributing
60+
61+
See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines, local setup, and PR expectations.

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Thanks for helping make GitHub safe for everyone.
2+
3+
# Security
4+
5+
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
6+
7+
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
8+
9+
## Reporting Security Issues
10+
11+
If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
12+
13+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
14+
15+
Instead, please send an email to opensource-security[@]github.com.
16+
17+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
18+
19+
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
* Full paths of source file(s) related to the manifestation of the issue
21+
* The location of the affected source code (tag/branch/commit or direct URL)
22+
* Any special configuration required to reproduce the issue
23+
* Step-by-step instructions to reproduce the issue
24+
* Proof-of-concept or exploit code (if possible)
25+
* Impact of the issue, including how an attacker might exploit the issue
26+
27+
This information will help us triage your report more quickly.
28+
29+
## Policy
30+
31+
See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
This project uses GitHub issues to track bugs and feature requests. Please search existing issues before creating a new one to avoid duplicates.
6+
7+
For help or questions about using this project, open a new GitHub issue in this repository and include:
8+
9+
- what you were trying to do
10+
- steps to reproduce (if applicable)
11+
- expected vs actual behavior
12+
- environment details (OS, Java version, Maven version)
13+
14+
**java-codespaces** is under active development and maintained by GitHub staff and the community. We will do our best to respond to support requests, feature requests, and community questions in a timely manner.
15+
16+
## GitHub Support Policy
17+
18+
Support for this project is limited to the resources listed above.

0 commit comments

Comments
 (0)