CONTRIBUTING.md

Contributing

The CORSIKA project is committed to fostering and preserving a diverse, welcoming community; all participants are expected to respect that.

• Getting Started
  • Very first steps
  • Opening issues
  • Participating in discussions
  • Improving and reviewing docs
  • Reviewing and testing changes
• Proposing and making changes
  • Finding something to work on
  • Before you start
  • Before you open your PR
  • Review process
• Getting more involved

Getting started

Not sure where to start? If you haven't already, take a look at the docs to get a better sense of the project. Read through some issues and some open PRs, to get a sense for the habits of existing contributors. Drop by the #xi channel on irc.mozilla.org to follow ongoing discussions or ask questions. Clone the repos you're interested in, and make sure you can build and run the tests. If you can't, open an issue, and someone will try to help. Once you're up and running, there are a a number of ways to participate:

Opening issues

If you have a question or a feature request or think you've found a bug, please open an issue. When opening an issue, include any details that might be relevant: for a bug this might be the steps required to reproduce; for a feature request it might be a detailed explanation of the behaviour you are imagining, an outline of how it would be used, and/or examples of how this feature is used in other editors.

Before you open an issue

Before opening an issue, try to identify where the issue belongs. Is it a problem with the frontend or with core? The frontend is responsible for drawing windows and UI, and handling events; the core is responsible for most everything else. Issues with the frontend should be opened in that frontend's repository, and issues with core should be opened in the xi-editor repo.

Finally, before opening an issue, use github's search bar to make sure there isn't an existing (open or closed) issue for your particular problem.