Skip to content

Commit 0eb9426

Browse files
committed
docs: update coc, contributing, readme
1 parent f281796 commit 0eb9426

File tree

3 files changed

+96
-1
lines changed

3 files changed

+96
-1
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at pjsier@gmail.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to `airtable-block-link-by-fields`
2+
3+
Thanks for your interest in contributing! We follow the ["fork and pull"](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models) model where contributors create personal forks of this repository, commit changes on a new branch, and then open pull requests for their updates to be reviewed and merged.
4+
5+
To get started, you can look for [issues labeled "help wanted"](https://github.com/pjsier/airtable-block-link-by-fields/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and post a comment that you're interested as well as any questions you have about the issue. If the issue is available you'll be assigned, and from there you can create a pull request with your updates.
6+
7+
All contributors are expected to follow our [code of conduct](./CODE_OF_CONDUCT.md).
8+
9+
## Pull Requests
10+
11+
GitHub has [documentation on creating pull requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests) that explains the overall workflow. By default, new pull requests should be opened against the `main` branch of this repo.
12+
13+
## Bug Reports
14+
15+
Find something that isn't working the way it should? First, take a look through our [existing issues](https://github.com/pjsier/airtable-block-link-by-fields/issues) to see if someone has already reported it, and if not feel free to create a new issue. If you're not sure if your issue has already been raised, go ahead and make a new one, we'd rather get a duplicate than miss a bug.
16+
17+
## Feature Requests
18+
19+
Have an idea for a useful feature that isn't currently supported? Review our [open issues](https://github.com/pjsier/airtable-block-link-by-fields/issues) to see if it's already been mentioned, and if not you can create a new issue to discuss it.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Build status](https://github.com/pjsier/airtable-block-link-by-fields/workflows/CI/badge.svg)](https://github.com/pjsier/airtable-block-link-by-fields/actions?query=workflow%3ACI)
44

5-
Airtable block for linking records by matching fields.
5+
Airtable block for linking records by matching fields. [Install in the Airtable marketplace](https://airtable.com/marketplace/blkQ7qqVJ3LgsfF0L/link-records-by-fields).
66

77
Select a table to update, linked records to fill in, and what fields should match to link records in bulk. You can also configure the options for matching including whether it should be case-sensitive and if existing linked record fields should be overwritten.
88

0 commit comments

Comments
 (0)