-
Notifications
You must be signed in to change notification settings - Fork 81
Contributing
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:
Most other things are probably fine though.
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.
-
Go to the issues here https://github.com/Hopson97/open-builder/issues
-
Check to see if your bug fix/suggestion/improvement exists
-
If it does exist:
-
Go to the issue and see if someone is already working on it (Assignments)
-
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)
-
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.
-
Fork repo, make a pull request etc :)
-
-
If it does not exist:
-
Raise an issue here https://github.com/Hopson97/open-builder/issues/new and label it appropriately
-
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)
-
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
-
Comment on the post to say you are going to work on that feature/fix/whatever..
-
Fork repo, make a pull request etc :)
-
-
When making a PR, please reference the issue using the # number thing
-
After a PR is made, I will do a code review to check its all good, and then merge it in