From 70d51a3e21c8b9dd118193218e708de6ab0f113d Mon Sep 17 00:00:00 2001 From: npruehs Date: Thu, 14 May 2020 13:09:16 +0200 Subject: [PATCH] Add documentation for contributing. --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 10 ++++++++-- 2 files changed, 55 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6a407bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +You'd like to help make Daedalic Test Automation Plugin even more awesome? Seems like today's our lucky day! In order to maintain stability of the plugin and its code base, please adhere to the following steps, and we'll be pleased to include your additions in our next release. + +Note that Daedalic Test Automation Plugin is distributed under the [MIT License](https://github.com/DaedalicEntertainment/ue4-test-automation/blob/develop/LICENSE). So will be your code. + +## How to contribute + +### Step 1: Choose what to do + +If you've got no idea how to help, head over to our [issue tracker](https://github.com/DaedalicEntertainment/ue4-test-automation/issues) and see what you'd like to do most. You can basically pick anything you want to, as long as it's not already assigned to anyone. + +If you know exactly what you're missing, [open a new issue](https://github.com/DaedalicEntertainment/ue4-test-automation/issues/new) to begin a short discussion about your idea and how it fits the project. If we all agree, you're good to go! + +### Step 2: Fork the project and check out the code + +Daedalic Test Automation Plugin is developed using the [GitFlow branching model](https://nvie.com/posts/a-successful-git-branching-model). In order to contribute, you should check out the latest `develop` branch, and create a new feature or hotfix branch to be merged back. + +### Step 3: Implement your feature or bugfix + +Clearly, everybody's got their own approach here. However, we'd still like you to keep a few things in mind, to ensure the stability and consistency of the plugin for everyone: + +* We're using our own [Coding Conventions](https://github.com/DaedalicEntertainment/unreal-coding-conventions), which are largely based on the official [Coding Standard](https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/index.html) provided by Epic Games. If you're used to working with that one, in general, you should be fine. +* When you're adding support for a newer engine version, make sure that you don't break support for previously supported engine versions. We must not force our users to upgrade their engine just because of updating the plugin. +* Note that renaming or reordering parameters is a breaking change. This includes the blueprint macro libraries shipped with the plugin. You should avoid that, if possible. + +### Step 4: Open a pull request + +Finally, [open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) so we can review your changes together, and finally integrate it into the next release. + + +## Release Checklist + +Internally, we're using the following checklist when preparing for a new release: + +* Check pending pull requests +* Create release branch +* Add examples for new features where appropriate +* Run all tests +* Update documentation (README, images) +* Increase version number (and engine version, if necessary) +* Create plugin package +* Check plugin package in another project +* Merge release branch with tag +* Add a new GitHub release with release notes +* Update GitHub issues and milestones +* Notify community (e.g. forums) diff --git a/README.md b/README.md index 888053c..df601bc 100644 --- a/README.md +++ b/README.md @@ -301,9 +301,10 @@ You'll always find all available releases and their respective release notes at: https://github.com/DaedalicEntertainment/ue4-test-automation/releases -## Bugs & Feature Requests -Daedalic Test Automation Plugin is still under heavy development. Whenever you're experiencing issues or are missing a feature, after verifying that you are using the [latest version](https://github.com/DaedalicEntertainment/ue4-test-automation/releases) and having checked whether a [similar issue](https://github.com/DaedalicEntertainment/ue4-test-automation/issues) has already been reported, feel free to [open a new issue](https://github.com/DaedalicEntertainment/ue4-test-automation/issues/new). In order to help us resolving your problem as fast as possible, please include the following details in your report: +## Bugs, Questions & Feature Requests + +Daedalic Test Automation Plugin is still under heavy development. Whenever you're experiencing issues, missing a feature, or you just don't understand a part of the plugin, after verifying that you are using the [latest version](https://github.com/DaedalicEntertainment/ue4-test-automation/releases) and having checked whether a [similar issue](https://github.com/DaedalicEntertainment/ue4-test-automation/issues) has already been reported, feel free to [open a new issue](https://github.com/DaedalicEntertainment/ue4-test-automation/issues/new). In order to help us resolving your problem as fast as possible, please include the following details in your report: * Steps to reproduce * What happened? @@ -312,6 +313,11 @@ Daedalic Test Automation Plugin is still under heavy development. Whenever you'r After being able to reproduce the issue, we'll look into fixing it immediately. +## Contributing + +You want to contribute to Daedalic Test Automation Plugin? Great! Take a look at [Contributing](CONTRIBUTING.md) to get started right away! + + ## Future Work While the plugin already serves as solid base for creating automated tests, there's still a lot of things we'd like to add in the future. If you're interested in more details, take a look at the [GitHub milestones](https://github.com/DaedalicEntertainment/ue4-test-automation/milestones).