Skip to content

Commit 1afca65

Browse files
committed
OS guidelines and README updates.
1 parent df49404 commit 1afca65

File tree

3 files changed

+116
-1
lines changed

3 files changed

+116
-1
lines changed

CODE_OF_CONDUCT.md

+76
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 making 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 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 hgraph@goinvo.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

CONTRIBUTE.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contribute
2+
3+
We welcome contributions in the form of [issues](https://github.com/hgraph-os/hGraph/issues/) or [pull requests](https://github.com/hgraph-os/hGraph/pulls). We recommend starting with an [issue](https://github.com/hgraph-os/hGraph/issues/new) to have a conversation before changing any files.
4+
5+
## Code of Conduct
6+
Help us keep hGraph open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
7+
8+
## Ways to Contribute
9+
10+
### Report issues
11+
- Ensure the issue was not already reported by searching on GitHub under [Issues](https://github.com/hgraph-os/hGraph/issues/).
12+
- If you're unable to find an open issue addressing the problem, open a [new issue](https://github.com/hgraph-os/hGraph/issues/new) and label it 'bug'. Be sure to include a title and clear description, as much relevant information as possible, and a text sample or an executable test case demonstrating the expected behavior that is not occurring.
13+
14+
### Suggest new features
15+
- Suggest your change as a [new issue](https://github.com/hgraph-os/hGraph/issues/new) and label it 'feature request' before writing any text.
16+
- The team will review your new feature and respond within 24 business hours.
17+
18+
### Edit text or documentation
19+
- No pull request is too small: fix typos, add comments, clean up inconsistent whitespace.
20+
- Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.
21+
- The team will review your pull request and respond within 24 business hours.
22+
23+
## Editing
24+
### Instructions
25+
First, make sure you're logged in with your Github account. When you have a change you wish to make, simply find the version of the document that you wish to change. Open it and press the Edit button.
26+
27+
On the edit page, you'll be presented with a version of the document. Edit the text you wish to change. When you are done editing, there will be a section at the bottom of the page to save your work. Under "Commit summary", enter a brief description of the change(s) you're making. In the "Extended description" field, explain what the changes are and why they're needed. Select the "Create a new branch for this commit..." option. When you're done, commit your changes.
28+
29+
At this point, you'll be presented with a form to submit a pull request. The bottom section of the page will show all of the changes you've made to the document, and all you should need to do is press the "Send Pull Request" button.
30+
31+
Once you've submitted a pull request, the PDUA team can review the work under the Pull Requests tab on the right-hand side, and a contributor to the repo can merge your changes.
32+
33+
### Markdown
34+
These files are written in the Markdown syntax. You can reference this [guide](https://www.markdownguide.org/basic-syntax/) for formatting (ex. Bold, Footnotes, Lists, Links).

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,12 @@ Founders/Designers: [GoInvo](http://www.goinvo.com) is a digital design studio i
9898

9999
## Contributing
100100

101-
### Code of Conduct
101+
### [Code of Conduct](CODE_OF_CONDUCT.md)
102+
hGraph has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
103+
104+
### [Contributing Guidelines](CONTRIBUTE.md)
105+
We encourage you to contribute to hGraph!
106+
See the [contributing guidelines](CONTRIBUTE.md) for how to proceed.
102107

103108
### License ###
104109
hGraph is [Apache 2.0](https://github.com/goinvo/hGraph/blob/master/LICENSE) licensed.

0 commit comments

Comments
 (0)