Skip to content

Contributing Guidelines

NathanKell edited this page Feb 16, 2015 · 3 revisions

Contributing

All contributions to this project must be made under the Creative Commons Attribution 4.0 International license (CC-BY-4.0).

All participation in the project must adhere to the Code of Conduct, given below. Realism Overhaul is made possible by the community, so many mods and config files are provided by people who care deeply about Kerbal Space Program and its players. Please be considerate when requesting help, or demanding changes.

We love contributions. Please don't worry if something has already been reported, or if you think the idea is silly, we'd love to hear from you.

If you do need help putting together a config file for Realism Overhaul, join us on the Realism Overhaul IRC channel, found at irc.esper.net - channel #RO Link to IRC Webchat or Link to HexChat - Free IRC Client

Basic Steps to Contribute

Contributing to Realism Overhaul is quite simple, and anyone can do it! Steps:

  • Find an issue, or select an unsupported mod in the REWORK folder (or from the WIP list)
  • Install that mod with Realism Overhaul (You might want to slim down your GameData folder on your testing installation of KSP, delete any mods that you're not directly testing).
  • Install Part Catalog so you can filter out everything except the parts you want to mess with. (You may have to click 'auto-tag' the first time you launch the game with this installed. It may take a while.)
  • Check over all the parts in the part pack.
  • If anything doesn't work, look at the Realism Overhaul .cfg file (located in the Realism Overhaul GameData directory) and see if you can figure out why. If you can't, ask here, someone will be able to help you! (For the basics of Module Manager Config Files, check out the Module Manager OP or ask questions. Always ask questions.
  • If you're really puzzled, often-times the output_log.txt can help. Have a look! Search for the part you think might be causing the problem, or just look at the end of the file and see why the game crashed.
  • Check the real life equivalents of the parts, make sure the stats match.
  • Once you have a nice polished mod, make a Fork of the Realism Overhaul Github Repo, update your file in there, and post a Pull Request (all outlined on the GitHub help page, or just ask for help)
  • One of the Realism Overhaul caretakers will review your changes, and post them to the Realism Overhaul mod once everything looks good, and you get to be added to the list of awesome people who helped make Realism Overhaul awesome!

Remember: No one starts out good at programming, or making KSP config files.
"Sucking at something is the first step to being sorta good at something!" -Jake the dog. So get out there and give it a shot!

Code of Conduct

1. Purpose

A primary goal of the Realism Overhaul project is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).

This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.

We invite all those who participate in the Realism Overhaul Project to help us create safe and positive experiences for everyone.

2. Open Source Citizenship

A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.

Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.

If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.

3. Expected Behaviour

  • Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
  • Exercise consideration and respect in your speech and actions.
  • Attempt collaboration before conflict.
  • Refrain from demeaning, discriminatory, or harassing behaviour and speech.
  • Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.

4. Unacceptable Behaviour

Unacceptable behaviours include: intimidating, harassing, abusive, discriminatory, derogatory or demeaning speech or actions by any participant in our community online, at all related events and in one-on-one communications carried out in the context of community business. Community event venues may be shared with members of the public; please be respectful to all patrons of these locations.

Harassment includes: harmful or prejudicial verbal or written comments related to gender, sexual orientation, race, religion, disability; inappropriate use of nudity and/or sexual images in public spaces (including presentation slides); deliberate intimidation, stalking or following; harassing photography or recording; sustained disruption of talks or other events; inappropriate physical contact, and unwelcome sexual attention.

5. Consequences of Unacceptable Behaviour

Unacceptable behaviour from any community member, including sponsors and those with decision-making authority, will not be tolerated.

Anyone asked to stop unacceptable behaviour is expected to comply immediately.

If a community member engages in unacceptable behaviour, the community organisers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).

6. If You Witness or Are Subject to Unacceptable Behaviour

If you are subject to or witness unacceptable behaviour, or have any other concerns, please notify a community organiser as soon as possible. Contact details are provided below.

Additionally, community organisers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behaviour feel safe. In the context of in-person events, organisers will also provide escorts as desired by the person experiencing distress.

7. Addressing Grievances

If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the project leader with a concise description of your grievance. Contact details are provided below.

8. Scope

We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venuesonline and in-personas well as in all one-on-one communications pertaining to community business.

9. Contact info

Jason Rapp

irc.esper.net / #RO

jasrapp@gmail.com

10. License and attribution

This Code of Conduct is distributed under a Creative Commons Attribution-ShareAlike license.

The Realism Overhaul Code of Conducted is based upon the Citizen Code of Conduct, Revision 2.0.

You can’t perform that action at this time.