Navigation Menu

Skip to content

Contributing

Matthew Hopson edited this page Mar 9, 2020 · 9 revisions

Preface

As this project is being created as part of a series, there are certain things I would like to implement myself for it.

As they are for the series, I will not be accepting pull requests for them. For a list of planned features for the series, please look here:

Plan For The Series

Most other things are probably fine though.

Contributing

To keep track of who is doing what, this project will use GitHub Issues

Contributing means a lot more than physically adding code to the project yourself, raising issues (link above) is a great way to suggest features for the game you'd like to see, and for someone to pickup and begin working on.

Steps

  1. Go to the issues here https://github.com/Hopson97/open-builder/issues

  2. Check to see if your bug fix/suggestion/improvement exists

  3. If it does exist:

    1. Go to the issue and see if someone is already working on it (Assignments)

    2. Check the labels. If it has "For Video", then it means I am going to work on it for a video (However, feel free to comment on the issue to add suggestions etc)

    3. If it doesn't have the "for video" label, and no one is working on it, then comment on the post to say you are going to work on that feature/fix/whatever.

    4. Fork repo, make a pull request etc :)

  4. If it does not exist:

    1. Raise an issue here https://github.com/Hopson97/open-builder/issues/new and label it appropriately

    2. Wait for me to check out your issue, this way I can see if it is for a video, or if it fits with the nature of the project. (As I have plans for the project that are 🤐, not all feature requests will be appropriate)

    3. If I comment on the issue and don't close it, and also don't add the "for video" label, then it is good to start working on

    4. Comment on the post to say you are going to work on that feature/fix/whatever..

    5. Fork repo, make a pull request etc :)

  5. When making a PR, please reference the issue using the # number thing

  6. After a PR is made, I will do a code review to check its all good, and then merge it in