Skip to content

Commit 05a4036

Browse files
author
AJ Keller
committed
ADD: new docs
1 parent ff8fb81 commit 05a4036

File tree

8 files changed

+247
-1229
lines changed

8 files changed

+247
-1229
lines changed
File renamed without changes.

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
:tada::clinking_glasses: First off, thanks for taking the time to contribute! :tada::clinking_glasses:
4+
5+
Contributions are always welcome, no matter how small.
6+
7+
The following is a small set of guidelines for how to contribute to the project
8+
9+
## Where to start
10+
11+
### Code of Conduct
12+
This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md).
13+
By participating you are expected to adhere to these expectations. Please report unacceptable behaviour to [[email protected]](mailto:[email protected])
14+
15+
### Contributing on Github
16+
17+
If you're new to Git and want to learn how to fork this repo, make your own additions, and include those additions in the master version of this project, check out this [great tutorial](http://blog.davidecoppola.com/2016/11/howto-contribute-to-open-source-project-on-github/).
18+
19+
### Community
20+
21+
This project is maintained by the [OpenBCI](www.openbci.com) and [NeuroTechX](www.neurotechx.com) community. Join the NeuroTechX Slack to check out our #devices channel, where discussions about OpenBCI takes place.
22+
23+
## How can I contribute?
24+
25+
If there's a feature you'd be interested in building, go ahead and we'll support you as much as we can. When you're finished submit a pull request to the master branch referencing the specific issue you addressed.
26+
27+
If you find a bug, or have a suggestion on how to improve the project, just fill out a [Github issue](../../issues)

0 commit comments

Comments
 (0)