Merge pull request #11 from taggedzi/code-of-conduct

Code of conduct

Author: taggedzi

CODE_OF_CONDUCT.md

@@ -0,0 +1,52 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and maintainers pledge to make participation in this project 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, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Using welcoming language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy toward other community members
+
+Examples of unacceptable behavior include:
+
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned with this Code of Conduct.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and also applies when an individual is officially representing the project in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer(s).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Enforcement Guidelines
+
+Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+1. **Correction** – A private or public clarification of expected behavior.
+2. **Warning** – A warning regarding continued behavior.
+3. **Temporary Ban** – A temporary ban from contribution or interaction.
+4. **Permanent Ban** – A permanent ban from the project community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.  
+For more information, see https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# Contributing to SimplicityPress
+
+Thanks for your interest in contributing! 🎉  
+Contributions of all kinds are welcome: bug reports, documentation improvements, ideas, and code.
+
+This project aims to stay **simple, readable, and predictable**, so a few guidelines help keep things consistent.
+
+---
+
+## Ways to Contribute
+
+### 🐞 Reporting Bugs
+
+- Use the **Bug report** issue template
+- Include:
+  - Steps to reproduce
+  - Expected vs actual behavior
+  - OS (Windows/Linux/macOS)
+  - CLI / GUI / API (if relevant)
+  - Logs or tracebacks (redact secrets)
+
+### 💡 Feature Requests
+
+- Use the **Feature request** issue template
+- Clearly describe the problem being solved
+- Keep scope focused and aligned with the project’s goals
+
+### ❓ Questions
+
+- Use **GitHub Discussions** for questions or ideas
+- If it turns out to be a bug, we may ask you to open an issue
+
+---
+
+## Development Setup
+
+### Requirements
+
+- Python **3.11+**
+- Git
+- A virtual environment (recommended)
+
+```bash
+python -m venv .venv
+source .venv/bin/activate  # Linux/macOS
+# or
+.venv\Scripts\activate     # Windows
+pip install -e .[dev]
+```
+
+### Running Tests
+
+This project uses **pytest** and **nox**.
+
+```bash
+pytest
+# OR 
+nox -s tests
+```
+
+---
+
+## Code Style & Quality
+
+- Follow existing project patterns and structure
+- Prefer clarity over cleverness
+- Keep functions focused and well-named
+- Add or update tests when behavior changes
+- Use type hints where practical
+
+Automated checks may include:
+
+- Formatting and linting
+- Type checking
+- Unit tests
+
+---
+
+## Pull Requests
+
+1. Create a feature branch from `main`
+2. Make focused, incremental commits
+3. Use **Conventional Commit** messages where possible:
+
+   - `feat:`
+   - `fix:`
+   - `docs:`
+   - `chore:`
+4. Open a Pull Request and fill out the PR template
+
+Pull requests are reviewed for:
+
+- Correctness
+- Readability
+- Test coverage (where appropriate)
+- Alignment with project scope
+
+---
+
+## Licensing
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
+
+---
+
+## Code of Conduct
+
+This project follows the **Contributor Covenant Code of Conduct**.
+By participating, you agree to uphold it. Please report unacceptable behavior to the project maintainer(s).
+
+---
+
+Thanks again for contributing — your help makes this project better! 🚀

README.md

@@ -1,5 +1,8 @@
 # SimplicityPress
 
+<!-- Badges -->
+[![CI](https://github.com/taggedzi/simplicitypress/actions/workflows/ci.yml/badge.svg)](https://github.com/taggedzi/simplicitypress/actions/workflows/ci.yml) [![Release](https://github.com/taggedzi/simplicitypress/actions/workflows/release.yml/badge.svg)](https://github.com/taggedzi/simplicitypress/actions/workflows/release.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/) [![Ruff lint](https://img.shields.io/badge/lint%20with-ruff-informational)](https://github.com/astral-sh/ruff) [![Mypy](https://img.shields.io/badge/type%20checking-mypy-informational)](https://mypy-lang.org/) [![Issues](https://img.shields.io/github/issues/taggedzi/simplicitypress.svg)](https://github.com/taggedzi/simplicitypress/issues) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/taggedzi/simplicitypress/pulls)
+
 SimplicityPress is a **minimal, library-first static site generator** designed for people who want a clean, predictable Markdown → HTML workflow without the complexity of full CMS platforms or heavyweight SSG ecosystems.
 
 If your needs are simple - posts, pages, tags, basic navigation, and clean output - SimplicityPress gives you a lightweight, transparent tool that is easy to understand, customize, and automate.
@@ -35,7 +38,7 @@ Install in editable mode:
 
 ```bash
 python -m pip install -e .
-````
+```
 
 Create a new site:
 
@@ -73,16 +76,16 @@ simplicitypress serve --site-root test-site --output test-site/public --no-build
 
 SimplicityPress treats **pages** as standalone, non-blog content - perfect for:
 
-* About
-* Contact
-* Projects
-* FAQ
-* Resume
-* Privacy Policy
+- About
+- Contact
+- Projects
+- FAQ
+- Resume
+- Privacy Policy
 
 Pages live under:
 
-```
+```bash
 content/pages/
 ```
 
@@ -102,25 +105,25 @@ This is the **About** page body.
 
 **Fields:**
 
-* `title` *(required)*
+- `title` *(required)*
   Human-readable title.
 
-* `slug` *(optional)*
+- `slug` *(optional)*
   Defaults to filename (`about` → `/about/`).
 
-* `show_in_nav` *(optional)*
+- `show_in_nav` *(optional)*
   Adds this page to the top navigation bar.
 
-* `nav_title` *(optional)*
+- `nav_title` *(optional)*
   Override display label in navigation.
 
-* `nav_order` *(optional)*
+- `nav_order` *(optional)*
   Controls global nav ordering (lower = earlier).
 
 Output:
 
-* URL → `/<slug>/`
-* File → `output/<slug>/index.html`
+- URL → `/<slug>/`
+- File → `output/<slug>/index.html`
 
 ---
 
@@ -130,7 +133,7 @@ Posts appear on the blog index and support dates, tags, summaries, and optional
 
 Posts live under:
 
-```
+```bash
 content/posts/
 ```
 
@@ -153,31 +156,31 @@ This is the **post body**, written in Markdown.
 
 **Post features:**
 
-* Must include a `date`.
-* Casually support tags → generate:
+- Must include a `date`.
+- Casually support tags → generate:
 
-  * `/tags/`
-  * `/tags/<tag>/`
-* Appear in:
+  - `/tags/`
+  - `/tags/<tag>/`
+- Appear in:
 
-  * Home page
-  * Pagination pages
-  * Tag listings
+  - Home page
+  - Pagination pages
+  - Tag listings
 
 Output:
 
-* URL → `/posts/<slug>/`
-* File → `output/posts/<slug>/index.html`
+- URL → `/posts/<slug>/`
+- File → `output/posts/<slug>/index.html`
 
 ---
 
 ## 🧭 Navigation
 
 The default theme includes:
 
-* **Home** (`/`)
-* **Tags** (`/tags/`)
-* Any **pages that opt in** with `show_in_nav = true`
+- **Home** (`/`)
+- **Tags** (`/tags/`)
+- Any **pages that opt in** with `show_in_nav = true`
 
 Navigation is intentionally simple - no dropdowns or multi-level menus.
 
@@ -202,11 +205,33 @@ After building, navigation might look like:
 
 Pages without `show_in_nav = true` remain accessible but unlisted.
 
-## Licensing
+---
+
+## 📚 Documentation
+
+See the `docs/` directory for in-depth guides:
+
+- Theme API & stability
+- Template variables & context
+- Writing templates from scratch
+
+---
+
+## 📦 Licensing
 
 - **SimplicityPress** is licensed under the **MIT License**.  
   See the [`LICENSE`](./LICENSE) file in the repository root.
 
 - SimplicityPress depends on third-party libraries which may be licensed under different terms
   (for example, **PySide6**, which is available under the **LGPL**).  
-  See the [`LICENSES/`](./LICENSES) directory for third-party license notices.
+  See the [`LICENSES/`](./LICENSES/) directory for third-party license notices.
+
+## 🤝 Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for how to get involved, coding standards, and contribution guidelines.
+
+---
+
+## 🛡 Security
+
+See [`SECURITY.md`](SECURITY.md) for reporting vulnerabilities.

SECURITY.md

@@ -0,0 +1,50 @@
+# Security Policy
+
+## Supported Versions
+
+Security fixes are applied to the **latest released version** of SimplicityPress.
+
+Older versions may not receive security updates. Users are encouraged to upgrade to the most recent release when possible.
+
+## Reporting a Vulnerability
+
+If you believe you have found a security vulnerability, please **do not open a public issue**.
+
+Instead, report it privately using one of the following methods:
+
+- GitHub **Security Advisories** (preferred, if enabled)
+- Email the project maintainer (see repository profile)
+
+Please include:
+
+- A clear description of the vulnerability
+- Steps to reproduce (if applicable)
+- Potential impact
+- Any relevant logs, screenshots, or proof-of-concept code
+
+You may redact sensitive information as needed.
+
+## Disclosure Process
+
+Once a report is received:
+
+1. The issue will be reviewed and validated
+2. A fix will be developed and tested
+3. A patched release will be published
+4. A security advisory may be issued if appropriate
+
+We aim to respond to security reports in a timely manner, but response times may vary depending on complexity and availability.
+
+## Scope
+
+This security policy applies to:
+
+- The SimplicityPress core library
+- CLI and GUI interfaces
+- Official release artifacts
+
+Third-party dependencies are subject to their own security policies.
+
+---
+
+Thank you for helping keep this project secure.