Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1987 Adding CONTRIBUTING.md #433

Merged
merged 9 commits into from
Dec 5, 2022
125 changes: 125 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via [issue on our bug tracker](https://trac.osgeo.org/osgeolive/report/1),
[OSGeoLive mailing list](https://lists.osgeo.org/mailman/listinfo/osgeolive), or any other method with the owners of this repository before making a change.

By submitting you are agreeing to make your content available via our [open license policy](https://live.osgeo.org/en/copyright.html).

In the same manner, when translating on Transifex, you are agreeing to make your translations following those licence terms.
neteler marked this conversation as resolved.
Show resolved Hide resolved

Please note we have a code of conduct, please follow it in all your interactions with the project.
kalxas marked this conversation as resolved.
Show resolved Hide resolved


## Pull Request Process

1. TO-DO

## Translation process
### Join a translation team and translate

1. Create an account or login on [Transifex](https://www.transifex.com/osgeo/osgeolive/)
2. Request joining a translation team
3. Translate !
4. Please consider adding your self to our [contributor list](https://github.com/OSGeo/OSGeoLive-doc/blob/master/contributors.csv), if you don't know how to use git, please contact a maintainer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now we have the egg-hen problem.
egg = sign contirbution agreement
hen = start translating, we will use your translations

the hen is already given, but we didnt have the egg

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Make the Pull Request (PR)

### Request a new language

1. TO-DO

## Code of Conduct

**Bakaniko's comment:** This part was part of the template, it can be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be in a separate file


### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

**Bakaniko's comment:** This is the official OSGeo Code of Conduct

Contributors to OSGeoLive are expected to act respectfully toward others in accordance with the [OSGeo Code of Conduct](https://www.osgeo.org/code_of_conduct/).

#### Diversity Statement

OSGeo welcomes and encourages participation by everyone. We are committed to being a community that everyone feels good about joining, and we will always work to treat everyone well. No matter how you identify yourself or how others perceive you: we welcome you.

#### Specific Guidelines

We strive to:

* Be open.
We invite anyone to participate in our community. We preferably use public methods of communication for project-related messages, unless discussing something sensitive. This applies to messages for help or project-related support, too; not only is a public support request much more likely to result in an answer to a question, it also makes sure that any inadvertent mistakes made by people answering will be more easily detected and corrected.

* Be empathetic, welcoming, friendly, and patient.
We work together to resolve conflict, assume good intentions, and do our best to act in an empathetic fashion. We may all experience some frustration from time to time, but we do not allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one. Note that we have a multi-cultural, multi-lingual community and some of us are non-native speakers. We should be respectful when dealing with other community members as well as with people outside our community.

* Be collaborative.
Our work will be used by other people, and in turn we will depend on the work of others. When we make something for the benefit of OSGeo, we are willing to explain to others how it works, so that they can build on the work to make it even better. Any decision we make will affect users and colleagues, and we take those consequences seriously when making decisions.

* Be inquisitive.
Nobody knows everything! Asking questions early avoids many problems later, so questions are encouraged, though they may be directed to the appropriate forum. Those who are asked should be responsive and helpful, within the context of our shared goal of improving OSGeo.

* Be careful in the words that we choose.
Whether we are participating as professionals or volunteers, we value professionalism in all interactions, and take responsibility for our own speech. Be kind to others. Do not insult or put down other participants.

* Be concise
Keep in mind that what you write once will be read by hundreds of persons. Writing a short email means people can understand the conversation as efficiently as possible. Short emails should always strive to be empathetic, welcoming, friendly and patient. When a long explanation is necessary, consider adding a summary.

Try to bring new ideas to a conversation so that each mail adds something unique to the thread, keeping in mind that the rest of the thread still contains the other messages with arguments that have already been made.

Try to stay on topic, especially in discussions that are already fairly large.

* Step down considerately.
Members of every project come and go. When somebody leaves or disengages from the project they should tell people they are leaving and take the proper steps to ensure that others can pick up where they left off. In doing so, they should remain respectful of those who continue to participate in the project and should not misrepresent the project’s goals or achievements. Likewise, community members should respect any individual’s choice to leave the project.

#### Anti-Harassment

Harassment and other exclusionary behaviour are not acceptable. This includes, but is not limited to:

Personal insults or discriminatory jokes and language, especially those using racist or sexist terms.
Offensive comments, excessive or unnecessary profanity.
Intimidation, violent threats or demands.
Sustained disruption of sessions or events.
Stalking, harassing photography or recording.
Unwelcome physical contact or sexual attention.
Repeated harassment of others. In general, if someone asks you to stop, then stop.
Posting (or threatening to post) other people’s personally identifying information (“doxing”).
Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history.
Advocating for, or encouraging, any of the above behaviour.

#### Reporting Guidelines

If you believe someone is breaking this code of conduct, you may reply to them, and point to this code of conduct. Such messages may be in public or in private, whatever is most appropriate. Assume good faith; it is more likely that participants are unaware of their bad behaviour than that they intentionally try to degrade the quality of the discussion. Should there be difficulties in dealing with the situation, you may report your concerns to event staff, a forum leader or the OSGeo Board. Serious or persistent offenders may be expelled from the event or forum by event organizers or forum leaders.

### Attribution

This CONTRIBUTING.md is inspired by [PurpleBooth/Good-CONTRIBUTING.md-template.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426)