Skip to content

Introduce CONTRIBUTING.md #6

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
marinofelipe merged 3 commits into from
Sep 19, 2025
Merged

Introduce CONTRIBUTING.md #6

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
395f804
Revise CONTRIBUTING.md for better clarity
marinofelipe Sep 19, 2025
40da1ba
Update CONTRIBUTING.md
maxheld Sep 19, 2025
865ced6
Update CONTRIBUTING.md
maxheld Sep 19, 2025
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
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing

When contributing to this repository, we encourage you to first discuss the change you wish to make via an issue before submitting a change.
We're not strict about this, and for small changes, feel free to open a pull request directly.

## Local development
To run it locally during development:

#### CLI
run `swift run spmgraph <command> <options>`

#### Xcode (with the debugger attached)

Leverage the [shared spmgraph xcscheme](./.swiftpm/xcode/xcshareddata/xcschemes/spmgraph.xcscheme)
- Update the scheme with a custom working directory
- Update the arguments with the path to your Package.swift
- **Do not commit** such changes

## Pull Request Process

- Aim to keep pull requests scoped to one feature to ease review
- Add tests to verify that the changes work (if possible)
- Include or update documentation for new or changed features