Merge pull request #1091 from SiboVG/issue-1067
[fixes #1067] Improve GitHub repository
This commit is contained in:
Joe Pfeiffer
GitHub
commit
143308f946
BIN
.github/OpenRocket_home.png
vendored
Normal file
BIN
.github/OpenRocket_home.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.1 MiB |
9
CITATION.cff
Normal file
9
CITATION.cff
Normal file
@ -0,0 +1,9 @@
|
||||
cff-version: 1.2.0
|
||||
message: "If you use this software, please cite it as below."
|
||||
authors:
|
||||
- family-names: "Niskanen"
|
||||
given-names: "Sampo"
|
||||
title: "OpenRocket"
|
||||
version: 15.03
|
||||
date-released: 2015-03-28
|
||||
url: "https://github.com/openrocket/openrocket"
|
||||
133
CODE_OF_CONDUCT.md
Normal file
133
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,133 @@
|
||||
# Contributor Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
||||
identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall
|
||||
community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
||||
any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email address,
|
||||
without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement by sending them a
|
||||
private email, message on Slack, or any other communication method that you find
|
||||
suitable.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of
|
||||
actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or permanent
|
||||
ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.1, available at
|
||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
||||
[https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
80
CONTRIBUTING.md
Normal file
80
CONTRIBUTING.md
Normal file
@ -0,0 +1,80 @@
|
||||
# Contributing to OpenRocket 🚀
|
||||
Hi, thank you for your interest in OpenRocket! 😊
|
||||
|
||||
I will guide you to contributing to OpenRocket, be it as a developer, tester or any other type of help that will launch - *pun intended* - OpenRocket to the next level.
|
||||
|
||||
Before I move on: time is money, so to save you time, get used to how OpenRocket is abbreviated with _OR_.
|
||||
|
||||
#### Table Of Contents
|
||||
[Testing](#testing)
|
||||
* [Reporting bugs](#reporting-bugs)
|
||||
* [Suggesting new features](#suggesting-new-features)
|
||||
|
||||
[Development](#development)
|
||||
* [Commit etiquette](#commit-etiquette)
|
||||
* [Pull requests](#pull-requests)
|
||||
|
||||
[Translation](#translation)
|
||||
|
||||
[Documentation](#documentation)
|
||||
|
||||
[Anything else](#anything-else)
|
||||
|
||||
## Testing
|
||||
OpenRocket is not perfect, but we need people to discover and clearly document all of its imperfections. The job of a tester is to discover bugs, formulate new feature requests and to test out software updates. 📝
|
||||
|
||||
### Reporting bugs
|
||||
Please be very concise when you post a new issue. Give a short and appropriate title, preferably with the '[Bug]'-tag in the beginning to indicate a bug.
|
||||
|
||||
When explaining the issue, the following elements are important:
|
||||
* Explain how you expected OpenRocket to behave, and how it behaved instead
|
||||
* Go through the different steps that you took to (re)create the issue
|
||||
* Include information about your operating system (e.g. 'macOS Monterey version 12.1') and which version of OpenRocket you are using (e.g. 'the latest unstable branch')
|
||||
* If applicable, include a Bug Report (preferably in a separate .txt file) of the exception that OpenRocket threw
|
||||
|
||||
Providing extra information like a screenshot, a screen recording, the .ork file that produced an error etc. really help understand and solve the issue more quickly.
|
||||
|
||||
### Suggesting new features
|
||||
If you would like to see a new feature implemented in OR, make a new issue for it. Preferably include the tag '[Feature Request]' in the issue's title.
|
||||
|
||||
Explain the new feature in detail:
|
||||
* Which new behavior would you like OR to have
|
||||
* Why is this new feature important
|
||||
|
||||
## Development
|
||||
Please read our [Developer's Guide](https://github.com/openrocket/openrocket/wiki/Developer%27s-Guide). If you still have questions about how to set up your environment, with which issues you should start etc., then don't be afraid to send us a message on [Slack](https://join.slack.com/t/openrocket/shared_invite/zt-dh0wtpc4-WmkSK1ysqAOqHa6eFN7zgA).
|
||||
|
||||
Developing OpenRocket may be daunting at first, but if you keep Google, your IDE's search and debug features, and the other developers as close friends, then you will easily create your first pull request.
|
||||
|
||||
If you want to work on a certain issue, you should first communicate that you want to work on that issue. This can be done by commenting on the issue something like 'I would like to work on this issue'. This ensures that no more than one person works on a given issue.
|
||||
|
||||
### Commit etiquette
|
||||
Please make use of **atomic commits**. This means: don't fix 10 different issues and cram them in one commit. Split up commits into smaller commits that fix only one issue/feature.
|
||||
|
||||
For example: I fixed an issue where a button was displayed as red instead of blue, but I also found that there was a typo in a text somewhere else. Then put the button-fix in a one commit, give it an appropriate name, and put the typo-fix in another commit. Atomic commits make it much easier for code reviewers to review the code changes.
|
||||
|
||||
Also give **useful names** to your commits. A good naming convention of a commit is in the form of '[#{GitHub issue number of the issue you are trying to fix}] {Commit subject}'.
|
||||
|
||||
Take the example of fixing the red button from issue #123: '[#123] Display red button as blue'. Mentioning '#123' will also automatically link your pull request to the corresponding issue. The commit subject should be short and precise. It is also very useful to include a git commit message body besides just the commit subject to explain why and how you made that commit.
|
||||
|
||||
### Pull requests
|
||||
Right, you've dug into the codebase, found that one nasty line that caused all your troubles and fixed it. It is now time to push your code and create a pull request of the branch from your own repository to the official repository. As your PR (Pull Request) text, it is good to have the following structure:
|
||||
|
||||
1. Explain briefly which issue that you are trying to solve, e.g. 'This PR solves #123 in which buttons were displayed as red instead of blue'
|
||||
2. Next explain what the underlying issue was, e.g. 'The problem was that by default Java swing displays buttons as red.'
|
||||
3. Next is how you fixed the issue, e.g. 'Fixed it by overriding the default button color to blue'
|
||||
4. Finally, for other people to test your code, it is good to include a jar file of your fixed OpenRocket. This can be done using ant ([more info here](https://github.com/openrocket/openrocket/wiki/Instructions-to-Build-from-Terminal)). You can upload this jar-file to e.g. Dropbox or Google Drive and include it in your PR, e.g. 'Here is a jar file for testing: ' or if you're really GitHub-savvy, you can add a hyperlink to the 'jar file'-text. If necessary, you can also include information on how to recreate the original issue so that testers can check whether your code solved the issue. If needed, you can also included information about the expected behavior so that others know what your solution should do.
|
||||
|
||||
You can take a look at example PR [#979](https://github.com/openrocket/openrocket/pull/979).
|
||||
|
||||
## Translation
|
||||
Both the OpenRocket software and the end-user documentation wiki site are multilingual. The job of a translator is to maintain the existing languages, or to make a new translation of an unlisted language. During the development sometimes new translation keys get added in the English language that are not simultaneously translated to other languages. The translator must therefor check which translation keys are still missing in his/her/they language.
|
||||
|
||||
How you can make/edit a translation can be found on [this site](http://openrocket.trans.free.fr/index.php?lang=en) or the [GitHub wiki](https://github.com/openrocket/openrocket/wiki/Instructions-for-translators).
|
||||
|
||||
## Documentation
|
||||
We have two main documentation channels: a [GitHub wiki](https://github.com/openrocket/openrocket/wiki) and an [OpenRocket wiki page](http://wiki.openrocket.info/Main_Page), both of which require regular updates to keep up to date with the latest developments in the software.
|
||||
|
||||
## Anything else
|
||||
Do you have the perfect voice for making OpenRocket tutorials, are you a graphical designer that screams to improve OR's design, or are you the salesman that can grow OR's influence? Then go for it! We highly appreciate any help that we get, in any shape or form. 🙃
|
||||
|
||||
23
README.md
23
README.md
@ -8,6 +8,8 @@ Overview
|
||||
|
||||
OpenRocket is a free, fully featured model rocket simulator that allows you to design and simulate your rockets before actually building and flying them.
|
||||
|
||||
|
||||
|
||||
The main features include:
|
||||
|
||||
* Six-degree-of-freedom flight simulation
|
||||
@ -20,15 +22,16 @@ Read more about it on the [OpenRocket Wiki](http://wiki.openrocket.info).
|
||||
|
||||
Installers
|
||||
----------
|
||||
OpenRocket maintains an installer for installing the software and Java runtime. You can find the installer for Windows at the link below. Installers for macOS and Linux are coming and will be added to this page when ready.
|
||||
OpenRocket maintains an installer for installing the software and Java runtime. You can find the installer below.
|
||||
|
||||
[OpenRocket 15.03 Installer (Windows)](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03-installer.exe)
|
||||
* [OpenRocket 15.03 Installer (Windows)](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03-installer.exe)
|
||||
* [OpenRocket 15.03 Installer (Mac OS)](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03.dmg)
|
||||
* [OpenRocket 15.03 Installer (Linux)](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03.AppImage)
|
||||
* [OpenRocket 15.03 JAR file](https://github.com/openrocket/openrocket/releases/download/release-15.03/OpenRocket-15.03.jar)
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
Release notes for all releases of OpenRocket are available at the following link.
|
||||
|
||||
[OpenRocket Release Notes](https://github.com/openrocket/openrocket/wiki/Release-Notes)
|
||||
Release notes are available on each [release's page](https://github.com/openrocket/openrocket/releases) or on [our website](https://openrocket.info/release_notes.html).
|
||||
|
||||
License
|
||||
-------
|
||||
@ -37,7 +40,7 @@ OpenRocket is an Open Source project licensed under the [GNU GPL](https://www.gn
|
||||
|
||||
Contributing
|
||||
------------
|
||||
OpenRocket needs help to become even better. Implementing features, writing documentation and creating example designs are just a few ways of helping. If you are interested in helping make OpenRocket the best rocket simulator out there, please [click here for information on how to get involved!](http://openrocket.sourceforge.net/getinvolved.html)
|
||||
OpenRocket needs help to become even better. Implementing features, writing documentation and creating example designs are just a few ways of helping. If you are interested in helping make OpenRocket the best rocket simulator out there, please [click here for information on how to get involved](http://openrocket.sourceforge.net/getinvolved.html) and [read the practicalities of contributing here](.github/CONTRIBUTING.md).
|
||||
|
||||
**Contributors**
|
||||
- Sampo Niskanen, main developer
|
||||
@ -47,6 +50,13 @@ OpenRocket needs help to become even better. Implementing features, writing docu
|
||||
- Richard Graham, geodetic computations
|
||||
- Jason Blood, freeform fin set import
|
||||
- Boris du Reau, internationalization
|
||||
- Daniel Williams, pod support, maintainer
|
||||
- Joe Pfeiffer (maintainer)
|
||||
- Billy Olsen (maintainer)
|
||||
- Sibo Van Gool (maintainer)
|
||||
- Neil Weinstock (tester, icons, forum support)
|
||||
- H. Craig Miller (tester)
|
||||
|
||||
|
||||
**Translators**
|
||||
- Tripoli France
|
||||
@ -56,3 +66,4 @@ OpenRocket needs help to become even better. Implementing features, writing docu
|
||||
- Sky Dart Team
|
||||
- Vladimir Beran
|
||||
- Polish Rocketry Society / Łukasz & Alex Kazanski
|
||||
- Sibo Van Gool
|
||||
|
||||
12
SUPPORT.md
Normal file
12
SUPPORT.md
Normal file
@ -0,0 +1,12 @@
|
||||
# OpenRocket support
|
||||
|
||||
OpenRocket has two main Wiki-pages for documentation:
|
||||
* [GitHub wiki](https://github.com/openrocket/openrocket/wiki)
|
||||
* [OpenRocket wiki](http://wiki.openrocket.info/Main_Page)
|
||||
* [OpenRocket website](https://openrocket.info/index.html)
|
||||
|
||||
Our main communication channel are:
|
||||
* [Slack](https://www.rocketryforum.com/forums/rocketry-electronics-software.36/) = **primary communication channel**
|
||||
* [OpenRocket forum](https://www.rocketryforum.com/forums/rocketry-electronics-software.36/)
|
||||
* [OpenRocket-devel mailing list](https://sourceforge.net/projects/openrocket/lists/openrocket-devel) for discussion related to OpenRocket development, documentation and upcoming features
|
||||
* [OpenRocket-announce mailing list](https://sourceforge.net/projects/openrocket/lists/openrocket-announce) for announcements of new OpenRocket versions and developments
|
||||
@ -42,6 +42,7 @@ public class AboutDialog extends JDialog {
|
||||
"Daniel Williams (pod support, maintainer)<br>" +
|
||||
"Joe Pfeiffer (maintainer)<br>" +
|
||||
"Billy Olsen (maintainer)<br>" +
|
||||
"Sibo Van Gool (maintainer)<br>" +
|
||||
"Neil Weinstock (tester, icons, forum support)<br>" +
|
||||
"H. Craig Miller (tester)<br><br>" +
|
||||
"<b>Translations by:</b><br><br>" +
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user