Skip to content

Commit 25649d1

Browse files
committed
Add contribution guide and code of conduct
1 parent 2ff2c16 commit 25649d1

File tree

4 files changed

+131
-14
lines changed

4 files changed

+131
-14
lines changed

CODE_OF_CONDUCT.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of
4+
fostering an open and welcoming community, we pledge to respect all people who
5+
contribute through reporting issues, posting feature requests, updating
6+
documentation, submitting pull requests or patches, and other activities.
7+
8+
We are committed to making participation in this project a harassment-free
9+
experience for everyone, regardless of level of experience, gender, gender
10+
identity and expression, sexual orientation, disability, personal appearance,
11+
body size, race, ethnicity, age, religion, or nationality.
12+
13+
Examples of unacceptable behavior by participants include:
14+
15+
- The use of sexualized language or imagery
16+
- Personal attacks
17+
- Trolling or insulting/derogatory comments
18+
- Public or private harassment
19+
- Publishing other's private information, such as physical or electronic
20+
addresses, without explicit permission
21+
- Other unethical or unprofessional conduct
22+
23+
Project maintainers have the right and responsibility to remove, edit, or reject
24+
comments, commits, code, wiki edits, issues, and other contributions that are
25+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
26+
contributor for other behaviors that they deem inappropriate, threatening,
27+
offensive, or harmful.
28+
29+
By adopting this Code of Conduct, project maintainers commit themselves to
30+
fairly and consistently applying these principles to every aspect of managing
31+
this project. Project maintainers who do not follow or enforce the Code of
32+
Conduct may be permanently removed from the project team.
33+
34+
This Code of Conduct applies both within project spaces and in public spaces
35+
when an individual is representing the project or its community.
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
38+
reported by contacting a project maintainer at andimarek@fastmail.fm. All
39+
complaints will be reviewed and investigated and will result in a response that
40+
is deemed necessary and appropriate to the circumstances. Maintainers are
41+
obligated to maintain confidentiality with regard to the reporter of an
42+
incident.
43+
44+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45+
version 1.3.0, available at
46+
[http://contributor-covenant.org/version/1/3/0/][version]
47+
48+
[homepage]: http://contributor-covenant.org
49+
[version]: http://contributor-covenant.org/version/1/3/0/

CONTRIBUTING.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,43 @@
11
# GraphQL Custom Scalars Specification Contribution Guide
22

3-
TODO
3+
Thanks for contributing to GraphQL Scalars.
4+
5+
The goal of the GraphQL Scalars project is to provide a directory of GraphQL
6+
Custom Scalar specifications, contributed by the community. Contributed
7+
specifications will be hosted on a GraphQL Foundation owned domain, which can be
8+
referenced with the built-in `@specifiedBy` GraphQL directive.
9+
10+
GraphQL Custom Scalar specifications are language agnostic and thus can be used
11+
to document and standardize behavior across different languages.
12+
13+
We will confirm the domain details soon. We are currently setting this up.
14+
15+
Please ensure that you read the [Code of Conduct](CODE_OF_CONDUCT.md) before
16+
contributing to this project.
17+
18+
## How to contribute
19+
20+
1. Copy the `template-string.md`
21+
[template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template-string.md)
22+
for Custom Scalars based on the built-in String Scalar, or otherwise use the
23+
`template.md`
24+
[template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template.md)
25+
for all other Custom Scalars. Templates are located in the
26+
[graphql-scalars GitHub repository](https://github.com/graphql/graphql-scalars/tree/main/scalars).
27+
28+
2. [Open a new pull request](https://github.com/graphql/graphql-scalars/pulls)
29+
for each Custom Scalar specification you would like to add.
30+
31+
3. Modify your selected template, and save it in the correct place
32+
`scalars/contributed/<github-user-name>/<scalar-name>.md` in the
33+
[graphql-scalars GitHub repository](https://github.com/graphql/graphql-scalars/tree/main/scalars/contributed).
34+
The directory location is important, as this will form part of the reference
35+
URL for your specification.
36+
37+
## Review process
38+
39+
Your specification will then be reviewed by a maintainer of the
40+
[graphql-scalars repository](https://github.com/graphql/graphql-scalars). The
41+
maintainers will verify that the template has been completed, but note that the
42+
correctness of the specification is the responsibility of the original
43+
contributor.

scalars/new-scalar.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,44 @@
1-
# Guide to contribute a new Custom Scalar specification
1+
# Custom Scalar specification contribution guide
22

3-
In order to contribute a new Custom Scalar specification, please open a new PR
4-
for each new Custom Scalar.
3+
Thanks for contributing to GraphQL Scalars.
54

6-
Use the "template-string.md" template for Custom Scalars based on the built-in
7-
String Scalar.
5+
The goal of the GraphQL Scalars project is to provide a directory of GraphQL
6+
Custom Scalar specifications, contributed by the community. Contributed
7+
specifications will be hosted on a GraphQL Foundation owned domain, which can be
8+
referenced with the built-in `@specifiedBy` GraphQL directive.
89

9-
Use the "template.md" template for all other Custom Scalars.
10+
GraphQL Custom Scalar specifications are language agnostic and thus can be used
11+
to document and standardize behavior across different languages.
1012

11-
Modify your selected template, and save it in the correct place
12-
"scalars/contributed/<github-user-name>/<scalar-name>.md". The directory
13-
location is important, as this will form part of the reference URL for your
14-
specification.
13+
We will confirm the domain details soon. We are currently setting this up.
14+
15+
Please ensure that you read the
16+
[Code of Conduct](https://github.com/graphql/graphql-scalars/blob/main/CODE_OF_CONDUCT.md)
17+
before contributing to this project.
18+
19+
## How to contribute
20+
21+
1. Copy the `template-string.md`
22+
[template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template-string.md)
23+
for Custom Scalars based on the built-in String Scalar, or otherwise use the
24+
`template.md`
25+
[template](https://github.com/graphql/graphql-scalars/blob/main/scalars/template.md)
26+
for all other Custom Scalars. Templates are located in the
27+
[graphql-scalars GitHub repository](https://github.com/graphql/graphql-scalars/tree/main/scalars).
28+
29+
2. [Open a new pull request](https://github.com/graphql/graphql-scalars/pulls)
30+
for each Custom Scalar specification you would like to add.
31+
32+
3. Modify your selected template, and save it in the correct place
33+
`scalars/contributed/<github-user-name>/<scalar-name>.md` in the
34+
[graphql-scalars GitHub repository](https://github.com/graphql/graphql-scalars/tree/main/scalars/contributed).
35+
The directory location is important, as this will form part of the reference
36+
URL for your specification.
37+
38+
## Review process
39+
40+
Your specification will then be reviewed by a maintainer of the
41+
[graphql-scalars repository](https://github.com/graphql/graphql-scalars). The
42+
maintainers will verify that the template has been completed, but note that the
43+
correctness of the specification is the responsibility of the original
44+
contributor.

scalars/template-string.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# This template is meant to be copied and modified
2-
3-
# This template is meant for Scalars which are based on the built-in String Scalar
1+
# This template is meant to be copied and modified. This template is meant for Scalars which are based on the built-in String Scalar
42

53
# Custom Scalar spec \<name\>
64

0 commit comments

Comments
 (0)