-
Notifications
You must be signed in to change notification settings - Fork 53
Setting Up to Contribute
Contributors to Ainneve collaborate on the code base using git, hosted on Github for version control.
Since you are reading this wiki hosted on Github, you are clearly aware of the Ainneve and Evennia Github repositories. However, for those who haven't contributed to a project on Github before, there can be a bit of a learning curve to get set up and ready to submit contributions. This document is meant as a quick-start overview to setting up to work on Ainneve.
- Confirm Evennia installation
- Fork the Ainneve project into your Github account
- Work in feature branches
- Submit your work to Ainneve in a Pull Request
All contributors should read the very fine Setting Up a Git Environment for Coding page in the Evennia wiki. The steps outlined within apply to Builders and Coders alike, and are nearly the same for contributing to either Ainneve or Evennia.
Many of the steps described here are very similar to those covered in Evennia's Developer Central wiki pages, but using the Ainneve github repository instead of Evennia.
We assume that folks who have read this far about Ainneve have gone through the process of installing Evennia as described on the Getting Started wiki page.
However, when following the instructions on that page, it is not necessary to go beyond step 9 in the quick start section. Steps 10-14 do not apply when working with Ainneve, because we will be cloning the game directory instead of creating a new one.
Follow the steps 1-3 in the Forking Evennia section of the version control page, but substituting the URL of the Ainneve repository (https://github.com/evennia/ainneve.git) in place of Evennia's.
Contributions should always be submitted within a feature or work branch as described on the Making A Work Branch page. It is best not to create pull requests from the master of your fork.
If your environment is set up correctly in step 2 above, Github will automatically select the Ainneve master as the merge target when you create a pull request.
A pull request is the beginning of a conversation about the change and a review of the code. Others may pull down your code to test it locally and find problems or make suggestions. You may be asked to write tests or documentation for the code you're submitting. We hope contributors take this process as an opportunity to learn and improve their knowledge and skills through feedback.