Skip to content

docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md) #726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mukller wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add community health files (CODE_OF_CONDUCT.md, CHANGELOG.md) #726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f4e155
docs: add CODE_OF_CONDUCT.md
Mukller Jul 9, 2026
fb51ec4
docs: add CHANGELOG.md
Mukller Jul 9, 2026
26f228e
docs: add Contributing & Code of Conduct section to README
Mukller Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Future features and improvements will be listed here

### Changed
- Ongoing updates and modifications

### Fixed
- Bug fixes and corrections

---

## How to Update This Changelog

When making changes, add an entry under `[Unreleased]` in the appropriate category:

- **Added** – new features
- **Changed** – changes to existing functionality
- **Deprecated** – soon-to-be removed features
- **Removed** – removed features
- **Fixed** – bug fixes
- **Security** – vulnerability fixes

When releasing, change `[Unreleased]` to the version number and date,
then add a new empty `[Unreleased]` section at the top.

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
Comment on lines +1 to +36

@coderabbitai coderabbitai Bot Jul 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep the release body free of authoring notes.

CHANGELOG.md is used directly as bodyFile in .github/workflows/publish_github.yml, so the update instructions and contributor attribution at the bottom will be published in every release. That will clutter the release notes and make them less useful. Please keep the release-facing content separate from the guidance text. CI also already reports a Prettier failure on this file.

🧰 Tools
🪛 GitHub Actions: Lint on push or pull request / 0_lint.txt

[warning] 1-1: Prettier check failed for this file ([warn] CHANGELOG.md). Run 'prettier --write' (via 'pnpm run format') to fix formatting.

🪛 GitHub Actions: Lint on push or pull request / lint

[warning] 1-1: Prettier reported a formatting/style issue in CHANGELOG.md (format check failed). Run 'prettier --write' to fix.

🪛 LanguageTool

[grammar] ~27-~27: Use a hyphen to join words.
Context: ...ctionality - Deprecated – soon-to-be removed features - Removed – removed...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` around lines 1 - 36, The release body currently includes
changelog guidance and contributor attribution, which will be published because
CHANGELOG.md is used as the GitHub release body file. Remove the “How to Update
This Changelog” section and the author attribution from the release-facing
content, keeping only the actual changelog entries under Unreleased in
CHANGELOG.md so the body stays clean; this should be updated in the same area
that feeds .github/workflows/publish_github.yml.

Source: Pipeline failures

67 changes: 67 additions & 0 deletions CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.
All complaints will be reviewed and investigated promptly and fairly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,15 @@ The generated code is using the LlamaIndex Server, which serves LlamaIndex Workf
- [LlamaIndex Server For Python](./python/llama-index-server/README.md)

Inspired by and adapted from [create-next-app](https://github.com/vercel/next.js/tree/canary/packages/create-next-app)


## Contributing

We welcome contributions of all kinds! Please read [CONTRIBUTING.md](CONTRIBUTING.md)
for guidelines on how to report bugs, suggest features, and submit pull requests.

By participating in this project, you agree to follow our
[Code of Conduct](CODE_OF_CONDUCT.md).

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
Loading