Skip to content
This repository has been archived by the owner on Sep 13, 2022. It is now read-only.

Latest commit

 

History

History
23 lines (18 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

23 lines (18 loc) · 2.3 KB
Raw

Contributing to xPilot

Thank you for your interest in contributing to the xPilot project!

Contributions

All contributions to this project should be made in the form of a GitHub pull request. Each pull request will be reviewed by the project owner. If the contribution is deemed to be beneficial, it will either be merged in or presented with feedback for changes that would be required. All accepted contributions will be licensed under GPLv3.

Getting started

The first thing you should do is search through the issues and pull requests to see if someone else had a similar idea or question.

Pull requests are the easiest (and most preferred) way to contribute changes because they offer a clean way for commenting and revising of proposed changes.

  1. Create a GitHub account if you don't already have one.
  2. Fork the project repository by clicking the Fork button on top right of the repository page. fork
  3. Clone your forked repository git clone https://github.com/xpilot-project/Plugin.git
  4. Add a new feature branch git checkout -b My-Feature-Branch
  5. Make changes to the code and commit them locally (your commit message should describe what the changes are)
  6. Push your new branch to your fork on GitHub git push -u origin My-Feature-Branch
  7. From your forked GitHub repository, open a pull request in the branch that contains your contributions. If you need to add additional commits to your pull request, you can commit the changes to your local branch and then use the git push command to automatically update your pull request.
  8. At this point, your contribution has been submitted for review. Any comments about your contribution will be posted in the pull request.
  9. If your contributions are approved, your pull request will be merged into the main project.

How do I test my changes on the network?

Development builds of xPilot are prohibited from being connected to the live VATSIM network for testing. If you have a development build that you would like to test, please contact Justin Shannon on the xPilot Discord for access to a FSD Developer server.