Skip to content

Commit 715d80b

Browse files
committed
Iterate on contributing document
1 parent 810b605 commit 715d80b

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
<!--
2+
This is a default contributing guide that applies to the entire testdouble organization.
3+
It may be overridden by a repo-specific contributing guide.
4+
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
5+
-->
6+
7+
# Contributing
28

3-
placeholder scaffolding for a base CONTRIBUTING file.
9+
<!--
10+
TODO:
11+
12+
fill out some generic contributing guidelines.
413
The contents of this file should be fairly generic as they will apply (by default) to all testdouble repos that don't have their own CONTRIBUTING file.
514
615
Probably some generic verbiage around accepting PRs;
716
whether we have an AI policy;
817
preference for tests and desire for simplicity, proof of value (does the value provided outweigh any additional complexity, etc)
918
10-
1119
It is useful for this document to serve two audiences:
1220
1) external contributors (who may or may not be first time contributors)
1321
2) but also as "internal" documentation for the maintainers (ie how to trigger/publish releases, etc)
1422
23+
I would propose that we have our testdouble recommendations for publishing/releasing to be documented here (fairly generically; again, this will be the default contributing doc for any testdouble repo that doesn't have its own.)
1524
-->

0 commit comments

Comments
 (0)