Skip to content

Commit a0ea57b

Browse files
authored
Merge pull request #6 from getyourguide/contributing-md
Introduce CONTRIBUTING.md
2 parents c3ac900 + 865ced6 commit a0ea57b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
When contributing to this repository, we encourage you to first discuss the change you wish to make via an issue before submitting a change.
4+
We're not strict about this, and for small changes, feel free to open a pull request directly.
5+
6+
## Local development
7+
To run it locally during development:
8+
9+
#### CLI
10+
run `swift run spmgraph <command> <options>`
11+
12+
#### Xcode (with the debugger attached)
13+
14+
Leverage the [shared spmgraph xcscheme](./.swiftpm/xcode/xcshareddata/xcschemes/spmgraph.xcscheme)
15+
- Update the scheme with a custom working directory
16+
- Update the arguments with the path to your Package.swift
17+
- **Do not commit** such changes
18+
19+
## Pull Request Process
20+
21+
- Aim to keep pull requests scoped to one feature to ease review
22+
- Add tests to verify that the changes work (if possible)
23+
- Include or update documentation for new or changed features

0 commit comments

Comments
 (0)