Skip to content

Commit ca34302

Browse files
whitewhite
authored andcommitted
Improve GitHub SEO: badges, topics, description, community files
- Add CI, Maven Central, Gradle Plugin Portal badges to README (EN + KO) - Enhance mkdocs.yml with site_author, copyright, social footer - Update repository description with richer keywords - Add 12 GitHub topics (java, python, cpython, jvm, etc.) - Create CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md - Enable GitHub Discussions and set homepage URL
1 parent 146e257 commit ca34302

7 files changed

Lines changed: 109 additions & 301 deletions

File tree

.output.txt

Lines changed: 0 additions & 300 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment:
18+
19+
- Demonstrating empathy and kindness toward other people
20+
- Being respectful of differing opinions, viewpoints, and experiences
21+
- Giving and gracefully accepting constructive feedback
22+
- Focusing on what is best for the community
23+
24+
## Enforcement
25+
26+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
27+
reported to the repository maintainer. All complaints will be reviewed and
28+
investigated promptly and fairly.

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to PythonEmbed
2+
3+
Thank you for your interest in contributing! Here's how to get started.
4+
5+
## Development Setup
6+
7+
```bash
8+
git clone https://github.com/howtis/python-embed.git
9+
cd python-embed
10+
./gradlew build
11+
```
12+
13+
Requirements: JDK 17+, Python 3.8+ (auto-downloaded if absent).
14+
15+
## Running Tests
16+
17+
```bash
18+
./gradlew test
19+
```
20+
21+
## Pull Request Process
22+
23+
1. Fork the repository and create a feature branch.
24+
2. Make your changes and add tests where appropriate.
25+
3. Run `./gradlew build` to verify everything passes.
26+
4. Submit a pull request with a clear description of your changes.
27+
28+
## Code Style
29+
30+
- Follow existing code style in each module.
31+
- Keep changes focused — one feature or fix per PR.
32+
- Match the existing comment frequency in the codebase.
33+
34+
## Reporting Issues
35+
36+
Use the [GitHub Issues](https://github.com/howtis/python-embed/issues) page. Include:
37+
38+
- PythonEmbed version
39+
- Java and Python versions
40+
- Steps to reproduce
41+
- Expected vs. actual behavior

README.ko.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# PythonEmbed
44

5+
[![CI](https://github.com/howtis/python-embed/actions/workflows/ci.yml/badge.svg)](https://github.com/howtis/python-embed/actions/workflows/ci.yml)
6+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.howtis/python-embed-runtime)](https://central.sonatype.com/artifact/io.github.howtis/python-embed-runtime)
7+
[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/io.github.howtis.python-embed)](https://plugins.gradle.org/plugin/io.github.howtis.python-embed)
58
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
69

710
Java에서 Python 코드를 실행하세요 — 완전한 CPython 호환성, 설정 불필요.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# PythonEmbed
44

5+
[![CI](https://github.com/howtis/python-embed/actions/workflows/ci.yml/badge.svg)](https://github.com/howtis/python-embed/actions/workflows/ci.yml)
6+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.howtis/python-embed-runtime)](https://central.sonatype.com/artifact/io.github.howtis/python-embed-runtime)
7+
[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/io.github.howtis.python-embed)](https://plugins.gradle.org/plugin/io.github.howtis.python-embed)
58
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
69

710
Run Python code from Java — with full CPython compatibility and zero setup.

0 commit comments

Comments
 (0)