Skip to content

Contribute to Ainex

So, you want to contribute to Ainex's development? Here are the steps you'll need to take to get started:

  • Have a computer capable of running Ainex, and install the required system components:
  • Learn the language
    • An often overlooked aspect to newcomers is having an understanding of the language the project is written in.
    • Ainex uses C++ 17 for development. If you don't know this language, you may learn the basics on YouTube, but it may take a while to get a full grasp of it.
    • In addition, to submit your contributions, you'll need to know how to use Git.
    • Here is a crash course on Git to help you out.
  • Learn to build Ainex from source
    This step should give you all you need to start developing Ainex with Visual Studio on Windows or Codelite on Linux.
  • Follow the style guide
    Run xb format before creating a pull request.

When you're ready, fork Ainex on GitHub, and push your changes. Then create a pull request on GitHub.

  1. Click the New Pull Request button at the top right of the page: Location of the "New Pull Request" button

  2. Click Compare Across Forks to compare with your fork: Link to "Compare Across Forks"

  3. Select your own fork from the list: Drop-down list of repositories

  4. Review your selection. Make sure you have selected the correct branch.

  5. Click Create Pull Request to confirm your selection: Location of the "Create Pull Request" button

  6. Write a title and description for your pull request. When you're done, press Create Pull Request. Demonstration of pull request submission