Skip to content

Commit f30050e

Browse files
committed
Updating contributing guidance and readme
1 parent 4d70f3e commit f30050e

3 files changed

Lines changed: 28 additions & 1 deletion

File tree

.github/workflows/auto-close-external-prs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
owner: context.repo.owner,
2121
repo: context.repo.repo,
2222
issue_number: pr,
23-
body: "Thanks for the interest! This repository isn't currently accepting external contributions as I am actively experimenting with different approaches and want to avoid merge conflicts. Therefore, this PR is being closed automatically by Github Bot."
23+
body: "Thanks for the interest! This repository isn't currently accepting external contributions as I am actively experimenting with different approaches and want to avoid merge conflicts. Therefore, this PR is being closed automatically by Github Bot. See [CONTRIBUTING.md](https://github.com/mccaffers/backtesting-engine-cpp/blob/main/CONTRIBUTING.md) for how to fork or file an issue instead."
2424
});
2525
await github.rest.pulls.update({
2626
owner: context.repo.owner,

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
Thanks for taking a look! This is an active solo experiment, and I'm grateful for the interest.
4+
5+
## I'm not accepting pull requests right now
6+
7+
This repository isn't currently accepting external contributions. I am actively experimenting with different approaches and want to avoid merge conflicts, so any PR opened from a non-owner account will be commented on and closed automatically by a GitHub bot.
8+
9+
Please don't take it personally — the policy is the same for everyone, and it isn't a judgement on the change.
10+
11+
## Please fork freely
12+
13+
The project is [MIT-licensed](LICENSE.MD), so you're very welcome to fork it and take the code in your own direction. If your fork sparks a discussion or you want to share what you've built on top of it, feel free to open an issue (see below).
14+
15+
## Use GitHub Issues for bugs, questions, and ideas
16+
17+
Bugs, questions, and ideas are all welcome on the [Issues tab](https://github.com/mccaffers/backtesting-engine-cpp/issues). That's the supported way to flag something — much more useful to me than a PR I'd have to close.
18+
19+
When filing an issue, a short description of what you saw, what you expected, and (for bugs) how to reproduce it goes a long way.
20+
21+
## A note on `@claude` mentions
22+
23+
This repo uses the [Claude Code GitHub Action](https://github.com/anthropics/claude-code-action) on `@claude` mentions, but it's restricted to the repository owner — `@claude` comments from other accounts won't trigger a run. This keeps paid API usage under control.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,9 @@ Xcode - Library Path
8282

8383
`bash ./scripts/test.sh`
8484

85+
### Contributing
86+
87+
This is an active solo experiment, so I'm not accepting pull requests right now — but please fork freely and use [GitHub Issues](https://github.com/mccaffers/backtesting-engine-cpp/issues) for bugs, questions, and ideas. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
88+
8589
### License
8690
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)