Skip to content

Commit 5cd037e

Browse files
Add files via upload
0 parents  commit 5cd037e

21 files changed

Lines changed: 2499 additions & 0 deletions

CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# This repository is maintained by:
2+
* @github/accessibility-design
3+
scenarios-framework.md @mattobee

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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 making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
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 <opensource@github.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 [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/github/annotation-toolkit/fork
4+
[pr]: https://github.com/github/annotation-toolkit/compare
5+
6+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's CC-BY 4.0 open source license](./LICENSE.md).
7+
8+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
9+
10+
## How can you contribute to the Figma library
11+
12+
We would love your feedback and contributions to help improve the Annotation Toolkit. As they're often used on proprietary and unreleased work, tools like this tend to be built and used in isolation. If you have customized this library for your own use, you can help this open source tool grow and evolve so that others can benefit from your innovation. **We are happy to consider integrating ideas you've explored in your own library forks and submitted as a new [issue](https://github.com/github/annotation-toolkit/issues).**
13+
14+
Due to how Figma handles open source files, we can only take _direct_ contributions from **GitHub staff**.
15+
16+
## GitHub staff contributions
17+
18+
1. To make changes you first need to create a new branch from Annotation Toolkit by selecting “Create branch...” from the dropdown or via the command palette. Name it `@username/changes-being-made`. For example: `@ericwbailey/update-basic-annotations`.
19+
2. When you are satisfied with the changes you made, request a review from the maintainers. If you are not sure who that is, reach out in the `#annotation-toolkit` slack channel. Add a detailed message describe what you changed and why.
20+
3. Once your branch is approved, a maintainer will take care of merging and publishing the changes to the library.
21+
22+
We use this process to make sure no accidental changes get added to the library. It also allows us to better track changes added by a branch. Think of it as a repo that does not allow direct pushes to the main branch.
23+
24+
### Merging contributions (for maintainers)
25+
Only maintainers with editor rights can merge contributions.
26+
27+
#### Process for merging branches
28+
1. Reset the main file to the latest release or the last time a branch was merged by hovering over the item, clicking the dots to show the more menu and selecting “restore version”.
29+
2. Open the branch and review & test everything to make sure it works
30+
3. Open the review window by clicking on the “In Review” badge next to the name
31+
4. Make sure there are no conflicts
32+
5. Merge the branch
33+
34+
### Publishing changes (for maintainers)
35+
Only maintainers with editor rights can publish changes.
36+
37+
#### Process for publishing releases
38+
1. Select “Publish library” from the dropdown next to the file name.
39+
2. In the dialog check that all changes that will be published are valid.
40+
3. Add a very descriptive description. This will be part of the release notes later so make sure to include what was changed and why.
41+
4. Press the “Publish” button and your release is done.

0 commit comments

Comments
 (0)