Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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)*
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing

Thank you for your interest in contributing! We appreciate all contributions,
from bug reports to feature requests and code improvements.

## How to Contribute

### Reporting Bugs
- Check existing [issues](../../issues) first to avoid duplicates
- Open a new issue with a clear title and description
- Include steps to reproduce, expected vs actual behavior, and environment details

### Suggesting Features
- Open an issue with the `enhancement` label
- Describe the feature and explain why it would be valuable

### Submitting Code

1. **Fork** this repository
2. **Create a branch** from `main`:
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes** and add tests if applicable
4. **Commit** with a clear message:
```bash
git commit -m "feat: add your feature description"
```
5. **Push** to your fork and open a **Pull Request**

## Guidelines

- Follow the existing code style and conventions
- Keep PRs focused on a single concern
- Write clear commit messages
- Update documentation when changing behavior
- Be respectful and constructive in all interactions (see [Code of Conduct](CODE_OF_CONDUCT.md))

## Development Setup

```bash
# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME

# Install dependencies (see README for details)
```

## Questions?

Open an issue or start a discussion — we're happy to help!

---
*Documentation contributed by [Mukller](https://github.com/Mukller)*
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,15 @@ See [Publishing data](https://docs.datasette.io/en/stable/publish.html) in the d
## Datasette Lite

[Datasette Lite](https://lite.datasette.io/) is Datasette packaged using WebAssembly so that it runs entirely in your browser, no Python web application server required. Read more about that in the [Datasette Lite documentation](https://github.com/simonw/datasette-lite/blob/main/README.md).


## 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)*