Skip to content

chore: OSS best practices + single-branch model #56

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
alphacrack wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: OSS best practices + single-branch model #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# EditorConfig — https://editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4

[*.{yml,yaml,json,toml}]
indent_size = 2

[*.md]
# Preserve trailing whitespace in Markdown (used for hard line breaks)
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
2 changes: 0 additions & 2 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ updates:
directory: "/"
schedule:
interval: "weekly"
target-branch: "development"
labels: ["infra", "needs-triage"]

# Dev dependencies (pytest, coverage tooling). The package itself has
Expand All @@ -14,5 +13,4 @@ updates:
directory: "/"
schedule:
interval: "weekly"
target-branch: "development"
labels: ["infra", "needs-triage"]
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,16 @@ word choice is especially welcome.

## 📬 Submitting changes

1. Fork the repository and create a topic branch off `development`
(not `main` — `main` is the released line).
1. Fork the repository and create a topic branch off `main`
(this project uses a single-branch model — `main` is the trunk,
and releases are tagged from it).
2. Make your changes in logical commits — one concern per commit.
Follow conventional-commit style where reasonable
(`fix(linter): ...`, `feat(cli): ...`).
3. Run `pytest` and make sure it's green.
4. Open a Pull Request targeting `development`. The PR template will
4. Open a Pull Request targeting `main`. The PR template will
prompt you for test evidence and any security considerations.
All PRs must pass the required `ci-ok` status check before merge.

## 📦 Releasing

Expand Down
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# README.md

# 📜 Devnagiri Maithili DSL

[![CI](https://github.com/alphacrack/python-maithili-dsl/actions/workflows/ci.yml/badge.svg)](https://github.com/alphacrack/python-maithili-dsl/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/python-maithili.svg)](https://pypi.org/project/python-maithili/)
[![Python versions](https://img.shields.io/pypi/pyversions/python-maithili.svg)](https://pypi.org/project/python-maithili/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

A modern Python-compatible programming DSL that lets you write code in **Maithili** using the **Devanagari script**.

---
Expand Down