Skip to content

Commit 6261285

Browse files
committed
docs(contributing): new dedicated contribution markdown file
1 parent 6a5293e commit 6261285

File tree

2 files changed

+48
-26
lines changed

2 files changed

+48
-26
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing Guidelines
2+
3+
Here are some general guidelines to please include in your PR to prevent potential revision requests.
4+
5+
* Make sure your code is formatted similar to the rest of the project
6+
* New code must have test coverage. See any *Test.cs for an example
7+
8+
## Pull Requests
9+
10+
This project conforms to the Git Flow branching strategy. Please do the following if you wish to create a pull request.
11+
12+
1. Place your code in a branch named `feature/MY_PR_TITLE` that branches off of `develop`
13+
1. Submit a pull request to the `develop` branch
14+
1. Verify all cloud checks pass without crashing
15+
1. Await a PR review for potential revisions or feedback
16+
1. Once the PR is approved it will be merged into `develop` and immediately available in the `nightly` branch
17+
18+
## Submitting New Tasks
19+
20+
If you want to submit new conditions, actions, decorators, or composites please keep the following in mind.
21+
22+
* Each task should be committed as an individual *feature* so it compiles to release notes properly
23+
* Tasks should include a custom white icon (preferably from https://material.io/tools/icons/). See any composite task for a good example
24+
* All tasks require integration with the tree builder script
25+
* You must also include documentation in the `README.md` that demonstrates how to use the task and what it does

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,11 @@ with units who attempt to capture the flag while grabbing power ups to try and g
160160
+ [Custom Conditions](#custom-conditions)
161161
+ [Custom Composites](#custom-composites)
162162
+ [Custom Decorators](#custom-decorators)
163+
* [Nightly Builds](#nightly-builds)
163164
* [Development Environment](#development-environment)
164-
+ [Making Commits](#making-commits)
165-
+ [Submitting your own actions, conditions, ect](#submitting-code-to-this-project)
166-
+ [Nightly Builds](#nightly-builds)
167-
* [Contributors](#contributors)
165+
+ [Submitting your own actions, conditions, ect](#making-commits)
166+
+ [Pull Requests / Contributing](#pull-requests--contributing)
167+
* [Contributor Credits](#contributor-credits)
168168

169169
## Example Scene
170170

@@ -677,7 +677,22 @@ public static class BehaviorTreeBuilderExtensions {
677677
}
678678
```
679679

680-
## Development
680+
## Nightly Builds
681+
682+
To access nightly builds of `develop` that are package manager friendly you'll need to manually edit your `Packages/manifest.json` as so.
683+
684+
```json
685+
{
686+
"dependencies": {
687+
"com.fluid.behavior-tree": "https://github.com/ashblue/fluid-behavior-tree.git#nightly"
688+
}
689+
}
690+
```
691+
692+
Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
693+
694+
695+
## Development Environment
681696

682697
If you wish to run to run the development environment you'll need to install [node.js](https://nodejs.org/en/). Then run the following from the root once.
683698

@@ -695,29 +710,11 @@ To make a commit type the following into a terminal from the root
695710
npm run commit
696711
```
697712

698-
### Submitting code to this project
713+
### Pull Requests / Contributing
699714

700-
Please do the following if you wish to contribute code to this project.
701-
702-
1. Create your feature in a `feature` branch off of `develop`
703-
2. Make sure your new code is reasonably tested to demonstrate it works (see `*Test.cs` files)
704-
3. Submit a pull request to the `develop` branch
705-
706-
### Nightly Builds
707-
708-
To access nightly builds of `develop` that are package manager friendly you'll need to manually edit your `Packages/manifest.json` as so.
709-
710-
```json
711-
{
712-
"dependencies": {
713-
"com.fluid.behavior-tree": "https://github.com/ashblue/fluid-behavior-tree.git#nightly"
714-
}
715-
}
716-
```
717-
718-
Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
715+
Please see the [Contributing Guidelines](CONTRIBUTING.md) document for more info.
719716

720-
## Contributors
717+
## Contributor Credits
721718

722719
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
723720

0 commit comments

Comments
 (0)