Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

25 lines (15 loc) · 1.52 KB
Raw

Contributing to Endless Sky

Posting issues

The issues page on GitHub is for tracking bugs and feature requests. When posting a new issue, please:

  • Check to make sure it's not a duplicate of an existing issue.
  • Create a separate "issue" for each bug you are reporting and each feature you are requesting.
  • Do not use the issues page for things other than bug reports and feature requests. Use the discussions page instead.

If requesting a new feature, first ask yourself: will this make the game more fun or interesting? Remember that this is a game, not a simulator. Changes will not be made purely for the sake of realism, especially if they introduce needless complexity or aggravation.

Posting pull requests

If you are posting a pull request, please:

  • Do not combine multiple unrelated changes.
  • Check the diff and make sure the pull request does not contain unintended changes.
  • If changing the C++ code, follow the coding standard.

If proposing a major pull request, start by posting an issue and discussing the best way to implement it. Often the first strategy that occurs to you will not be the cleanest or most effective way to implement a new feature.

Closing issues

If you believe your issue has been resolved, you can close the issue yourself. If your issue gets closed because a PR was merged, and you are not satisfied, please open a new issue.