Skip to content

docs: add community health files and document bootstrap env #13

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

Merged
JacksonFergusonDev merged 3 commits into from
Jan 19, 2026
Merged

docs: add community health files and document bootstrap env #13

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
0456959
docs: add code of conduct and contributing guidelines
JacksonFergusonDev Jan 19, 2026
3d56f18
docs: add environment bootstrap feature to README
JacksonFergusonDev Jan 19, 2026
b68d788
chore(config): update bumpversion message to conventional commits
JacksonFergusonDev Jan 19, 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
32 changes: 32 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,32 @@
# 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, 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

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project maintainers. All complaints will be reviewed and
investigated promptly and fairly.
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributing to Git Pulsar

First off, thanks for taking the time to contribute! 🎉

## How to Contribute

### Reporting Bugs
1. Check if the issue has already been reported.
2. Open a new issue with a clear title and description.
3. Include relevant logs (`git-pulsar log`) or reproduction steps.

### Development Setup

This project uses [uv](https://github.com/astral-sh/uv) for dependency management and Python 3.12+.

1. **Fork & Clone**
Fork the repo and clone it locally:
```bash
git clone https://github.com/jacksonfergusondev/git-pulsar.git
cd git-pulsar
```

2. **Environment Setup**
We use `uv` to manage the virtual environment and dependencies.
```bash
# Creates .venv and installs dependencies (including dev groups)
uv sync
```

*Optional: If you use `direnv`, allow the automatically generated configuration:*
```bash
direnv allow
```

3. **Install Hooks**
Set up pre-commit hooks to handle linting (Ruff) and type checking (Mypy) automatically.
```bash
pre-commit install
```

### Running Tests

We use `pytest` for the test suite.

```bash
uv run pytest
```

### Pull Requests

1. **Create a Branch**
```bash
git checkout -b feature/my-amazing-feature
```

2. **Make Changes**
Write code and add tests for your changes.

3. **Verify**
Ensure your code passes the linter and tests locally.
```bash
uv run pytest
```
(Pre-commit will also run `ruff` and `mypy` when you commit).

4. **Commit & Push**
Please use clear commit messages.
```bash
git commit -m "feat: add support for solar flares"
git push origin feature/my-amazing-feature
```

5. **Open a Pull Request**
Submit your PR against the `main` branch.
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ It ensures that even if your laptop dies (or you forget to push before leaving t

---

## 🧬 Environment Bootstrap (macOS)

Pulsar includes a one-click scaffolding tool to set up a modern, robust Python environment.

```bash
git-pulsar --env
```

This bootstraps the current directory with:

- **uv:** Initializes a project with fast package management and Python 3.12+ pinning.

- **direnv:** Creates an .envrc for auto-activating virtual environments and hooking into the shell.

- **VS Code:** Generates a .vscode/settings.json pre-configured to exclude build artifacts and use the local venv.

---

## 📦 Installation

### macOS (Recommended)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
allow_dirty = false
commit = true
message = "Bump version: {current_version} → {new_version}"
message = "chore: bump version {current_version} → {new_version}"
commit_args = ""

[[tool.bumpversion.files]]
Expand Down