Skip to content

Commit e1c5ec1

Browse files
committed
docs: add contributing guidelines
1 parent 955d1d6 commit e1c5ec1

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to git-time-machine
2+
3+
Thanks for wanting to contribute! Here are a few guidelines to keep things smooth.
4+
5+
## Before You Start
6+
7+
- Check the [Issues](https://github.com/dinakars777/git-time-machine/issues) page for open tasks. Issues labeled `good first issue` are great starting points.
8+
- Comment on the issue you want to work on so others know it's taken.
9+
10+
## Pull Request Guidelines
11+
12+
- **One issue per PR.** Keep PRs focused on a single feature or fix. If you want to tackle multiple issues, open separate PRs for each.
13+
- **Link the issue.** Include `Closes #<number>` in your PR description so the issue gets closed automatically when merged.
14+
- **Rebase on latest main.** Before opening your PR, make sure your branch is up to date with `main` to avoid merge conflicts.
15+
16+
## Code Quality
17+
18+
- Run `cargo check` before submitting to make sure everything compiles.
19+
- Run `cargo fmt` to keep formatting consistent.
20+
- Run `cargo clippy` to catch common mistakes.
21+
- If you're adding a new dependency to `Cargo.toml`, explain why it's needed in the PR description.
22+
23+
## What Happens After You Submit
24+
25+
- CI will automatically run `cargo check`, `cargo build`, and `cargo test` on your PR.
26+
- If CI fails, check the logs and push a fix.
27+
- Once reviewed and approved, your PR will be squash-merged into `main`.
28+
29+
## Questions?
30+
31+
Open a [Discussion](https://github.com/dinakars777/git-time-machine/discussions) or comment on the relevant issue. Happy hacking!

0 commit comments

Comments
 (0)