Skip to content

Commit f751dc6

Browse files
authored
[DEVREL-408] Add contributing.md file (#59)
* WIP - add contributing.md * Touch ups to contribute * Create CODE_OF_CONDUCT.md * Update contributing.md * Update contributing.md * Remove example of commit with version increase
1 parent 3b6595a commit f751dc6

2 files changed

Lines changed: 61 additions & 0 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Code of Conduct
2+
3+
In the interest of fostering an open and welcoming environment, we as
4+
contributors and maintainers pledge to making participation in our project and
5+
our community a harassment-free experience for everyone, regardless of age, body
6+
size, disability, ethnicity, gender identity and expression, level of experience,
7+
nationality, personal appearance, race, religion, or sexual identity and
8+
orientation.
9+
10+
### Our Standards
11+
12+
Examples of behavior that contributes to creating a positive environment
13+
include:
14+
15+
* Using welcoming and inclusive language
16+
* Being respectful of differing viewpoints and experiences
17+
* Gracefully accepting constructive criticism
18+
* Focusing on what is best for the community
19+
* Showing empathy towards other community members
20+
21+
Examples of unacceptable behavior by participants include:
22+
23+
* The use of sexualized language or imagery and unwelcome sexual attention or
24+
advances
25+
* Trolling, insulting/derogatory comments, and personal or political attacks
26+
* Public or private harassment
27+
* Publishing others' private information, such as a physical or electronic
28+
address, without explicit permission
29+
* Other conduct which could reasonably be considered inappropriate in a
30+
professional setting
31+
32+
33+
### Attribution
34+
35+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
36+
available at [http://contributor-covenant.org/version/1/4][version]
37+
38+
[homepage]: http://contributor-covenant.org
39+
[version]: http://contributor-covenant.org/version/1/4/

.github/contributing.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
## Pull Request Process
6+
7+
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to our repos or how we handle your PRs.
8+
9+
1. Ensure any build dependencies or sensitive environment variables are removed before posting your PR.
10+
2. In the PR summary, note the features you're adding or changes to existing interfaces.
11+
3. The versioning scheme we use is [SemVer](http://semver.org/).
12+
4. Please squash-merge commits into your PR -- this keeps our history tidy.
13+
5. We'd appreciate if your PR follows the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) spec.
14+
6. Pull Requests are typically merged once they receive approval from two Frame.io developers. If you haven't gotten approval, feel free to @mention us or send a reminder.
15+
16+
## Testing
17+
18+
We run tests using [pytest](https://docs.pytest.org/en/stable/). Tests are admittedly weak in this repo, you can help change that! One rule we care about: any tests run against actual Frame.io processes (like generating assets) should be accompanied by a teardown or cleanup task.
19+
20+
## Report a Bug
21+
22+
Report bugs to Issues in GitHub. It's okay to report bugs that may not be specific to this library, i.e. if you find a bug core to the API feel free to report it. Try to include info and context that will help us reproduce the problem.

0 commit comments

Comments
 (0)