Skip to content

Commit 52b652f

Browse files
romeokienzlerromeokienzler
committed
add documentation for contributors IBM#89 
1 parent 74a24ad commit 52b652f

File tree

5 files changed

+120
-0
lines changed

5 files changed

+120
-0
lines changed

‎CODEOWNERS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
@CarlosGomes98
2+
@Joao-L-S-Almeida
3+
@PedroConrado
4+
@biancazadrozny
5+
@romeokienzler

‎CODE_OF_CONDUCT.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
## TerraTorch Community Code of Conduct 1.0
2+
3+
4+
### Our Pledge
5+
6+
As contributors and maintainers of this project, and in the interest of fostering
7+
an open and welcoming community, we pledge to respect all people who contribute
8+
through reporting issues, posting feature requests, updating documentation,
9+
submitting pull requests or patches, and other activities.
10+
11+
We are committed to making participation in this project a harassment-free experience for
12+
everyone, regardless of level of experience, gender, gender identity and expression,
13+
sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
14+
religion, or nationality.
15+
16+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
17+
inclusive, and healthy community.
18+
19+
### Our Standards
20+
21+
Examples of behavior that contributes to a positive environment for our community include:
22+
23+
* Demonstrating empathy and kindness toward other people
24+
* Being respectful of differing opinions, viewpoints, and experiences
25+
* Giving and gracefully accepting constructive feedback
26+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
27+
* Focusing on what is best not just for us as individuals, but for the overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
43+
and will take appropriate and fair corrective action in response to any behavior that they deem
44+
inappropriate, threatening, offensive, or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
47+
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct,
48+
and will communicate reasons for moderation decisions when appropriate.
49+
50+
## Scope
51+
52+
This Code of Conduct applies within all community spaces including Matrix, issue trackers, wikis,
53+
blogs, Twitter, and any other communication channels used by our community, and also applies when
54+
an individual is officially representing the community in public spaces. Examples of representing
55+
our community include using an official e-mail address, posting via an official social media account,
56+
or acting as an appointed representative at an online or offline event.
57+
58+
## Enforcement
59+
60+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
61+
leaders responsible for enforcement via Matrix channel to the CLAIMED Project Management Committee at
62+
#claimed-pmc:matrix.org. All complaints will be reviewed and investigated promptly and fairly.
63+
64+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
65+
66+
67+
## Attribution
68+
69+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
70+
version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

‎CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
{% comment %}
3+
Copyright 2018-2024 IBM
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
{% endcomment %}
17+
-->
18+
19+
# Contributing
20+
21+
Welcome to TerraTorch! If you are interested in contributing to the [TerraTorch code repo](README.md)
22+
then checkout the [Contribution Process](contribution_process.md) and
23+
the [Code of Conduct](CODE_OF_CONDUCT.md)).
24+
25+
The [erraTorch code repo]([https://github.com/IBM/terratorch/blob/main/README.md)) contains information on how the community
26+
is organized and other information that is pertinent to contributing.
27+
28+
### Getting Started
29+
30+
It's encouraged that you look under the [Issues]([https://github.com/IBM/terratorch/issues)) tab for contribution opportunites.
31+
32+
Please also take the opportunity to join our [weekly community call](https://teams.microsoft.com/l/meetup-join/19%3ameeting_MWJhMThhMTMtMjc3MS00YjAyLWI3NTMtYTI0NDQ3NWY3ZGU2%40thread.v2/0?context=%7b%22Tid%22%3a%22fcf67057-50c9-4ad4-98f3-ffca64add9e9%22%2c%22Oid%22%3a%227f7ab87a-680c-4c93-acc5-fbd7ec80823a%22%7d) every Thursday 7 AM PST, 10 AM EST, **2 PM UTC**, 4 PM CET, 7:30 PM IST, 11 PM JST, 12 AM AEST

‎VULNERABILITIES.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# VULNERABILITIES reporting process
2+
3+
Vulnerabilities can be reported on the GitHub Issue Tracker.
4+
We are working on a more generic channel and update this information accordingly

‎contribution_process.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contribution Process
2+
3+
If you want to contribute to this project, there are many valuable ways in doing so
4+
5+
1. Join the weekly community calls as indicated in [CONTRIBUTING.md](CONTRIBUTING.md)
6+
1. Use / test TerraTorch and create an [Issue](https://github.com/IBM/terratorch/issues) if something is not working properly or if you have an idea for a feature request.
7+
1. Pick an [Issue](https://github.com/IBM/terratorch/issues) and start contributing
8+
9+
Contributions are welcome as pull requests on a [fork](https://github.com/IBM/terratorch/fork) of this project. Ideally, pull requests are backed by an [Issue](https://github.com/IBM/terratorch/issues). You can also tag the [code owners](https://github.com/IBM/terratorch/blob/main/CODEOWNERS) in the issue before you start, so we can talk about the details (in case you can't join one of the community calls).

0 commit comments

Comments
 (0)