Contributing Guidelines

So you have decided to contribute to projects at Xenode Studio. Thank you for your interest in contributing to Xenode🎉 We welcome contributions from the community and appreciate your support in making our game engine better.

The following is a set of guidelines for contributing to the Xenode Game Engine and other projects by Xenode Studio.

WARNING

By participating to contribute to our projects, it is expected to uphold the Code of Conduct

TIP

We use GitHub to manage our repositories. If you’re not familiar with git/GitHub, we strongly recommend following a tutorial, such as this one.

Ways to contribute

Whether you are a developer, a designer, a game developer or a just like game engines in general, there are lots of ways to contribute. Here's a few ideas:

• Try building and running Xenode on your local machine. Does it work? Does it do what you'd expect? If not, open an issue and let us know.
• Show some involvement on the project's open issues. Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
• Read through the documentation, and ask the community, any time you see something confusing, or have a suggestion for something that could be improved.
• Find an open issue (especially those labeled help wanted/good first issue), mention yourself in the comment with the interest to work on the issue and submit a proposed fix. If it’s your first pull request, we promise we won’t bite, and are glad to answer any questions.
• Help evaluate open pull requests, by testing the changes locally and reviewing what’s proposed.
• Open an issue if you found something that needs a fix (Please don’t forget to mention if you want to work on the issue you opened or have started working for a fix!)

Contributing the source code

WARNING

• Before you start working on an issue, kindly ensure that no one else is already working on the issue.
• If nobody is working on that issue, drop a comment to let everyone know that you will be working on the issue.

Prepare your working tree.

1. Click here to open the source code of Xenode in Github.
2. Fork the project by clicking on "Fork" on the top right corner area.
3. Clone the repository locally

git clone --recursive https://github.com/<your-username>/Xenode

4. Create a new, descriptively named branch to contain you code changes.

git checkout -b my-new-branch-that-does-this

Obtain the source code and build.

Click here to obtain instructions to build Xenode.

Making Code Changes.

Now that you've successfully built Xenode from source, hack your way into the source code. Just make sure to:

• Follow the code style used in the module you are contributing to.
• before committing and pushing the changes, test the code both manually and automatically with the automated test suite if applicable.

Submitting a Pull Request(PR)

Follow the following to steps to raise a PR:

• Navigate to your fork on GitHub and open the Pull Requests tab.
• Create a new Pull Request.
• Select the base and compare branches.
• Fill out the PR form.
  • Write a title and description for your pull request. Be clear about what changes you made and why.
• Submit the Pull Request by clicking the "Create Pull Request" button.

Thank You❤️

If you follow these guidelines closely your contribution will have a very positive impact on the Xenode Project.

Thanks a lot for your patience.