diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..164aae81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. Is it a bug during playback or a bug in editing Flowcharts, Blocks, Commands, and so on? When and where it is happening, is it only in editor or only in build or both? + +**To Reproduce** +In order for someone else to attempt to solve the issue we need to know how to make it occur. As such when reporting bugs please detail how to make them occur in existing FungusExample scenes, or how to create a scene from empty, or attach a unitypackage with a minimal scene in it. +Then describe the steps to reproduce the behavior: +1. Go to the scene '...' in the FungusExample ***OR*** In a new scene, add the following '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Versions & Platform (please complete the following information):** + - Unity version [e.g. 2019.2.20f1 or 2017.4.25] + - Fungus Version[e.g. v.3.12.0] This can be found in your Docs/ChangeLog or via Preferences->Fungus + - Editor OS: [e.g. Win 10 or OSX Mavericks] + - Build Platform [e.g. WebGL, Windows IL2CPP, iOS, Android] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..715fe44b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +Please double check the feature or suggestion you have has not already been raised by searching within the existing [issues](https://github.com/snozbot/fungus/issues). If you find something similar to what you were thinking, please reply to the existing issue with either additional details/suggestions or simply a +1. + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..4ed64e02 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,42 @@ +🚨Before submitting this PR. +- Please review the [guidelines for contributing](./CONTRIBUTING.md) to this repository. +- We welcome the submission of incomplete PRs, for comment, feedback, or assistance. Please prefix the PR with [WIP]. +- Make sure you are making a pull request against the **develop branch** (left side). Also you should start *your branch* off *develop*. +- Make sure you are requesting to **pull a topic/feature/bugfix branch** (right side). We don't recommend you request from your master! +- Check the commit's or even all commits' message styles matches our style and structure. +- Check your code additions pass all tests. +- Check your code additions have not negatively impacted or altered the behaviour of the FungusExamples. +- If adding a new feature, ensure you have added a demo to the FungusExamples and if possible added Tests too. + +💔Thank you! With that done and out of the way, you can remove all the above text and get to submitting this PR. + +### Description + + +### What is the current behavior? + + +### What is the new behavior? + +- +- +- + +### Important Notes + + +- [ ] My change require changes to documentation +- My changes modify + - [ ] the editing of flowcharts/blocks/commands etc. + - [ ] the runtime execution of existing Fungus Features. e.g., Say, Menus, Portraits, etc. +- [ ] My change adds additional tests +- [ ] My change modifies existing FungusExamples + + + + +### Other information + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..298adacd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,33 @@ +# Code of conduct + +# TL;DR # +Be nice to each other :) + +We want an open and respectful community at Fungus. So we would ask you when communicating (for example, posting on our Forums, Comments or github repository ) to be friendly and helpful. We find, for most people, this is not a problem. Our list of guidelines below is not exhaustive but should give a strong indication of what we consider acceptable community behaviour. + +# Be welcoming # +We welcome and support people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability. + +# Be respectful # +It's ok to disagree with someone. It's not ok to personally attack someone. Instead, focus on helping to resolve issues and learning from mistakes. + +Bullying or Harassment will not be tolerated +The following behaviours are not acceptable: + +- Violent threats or language directed against another person. +- Sexist, racist, or otherwise discriminatory jokes and language. +- Posting sexually explicit or violent material. +- Posting (or threatening to post) other people's personally identifying information ("doxing"). +- Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history. +- Personal insults, especially those using racist or sexist terms. +- Unwelcome sexual attention. +- Excessive or unnecessary profanity. +- Repeated harassment of others. In general, if someone asks you to stop, then stop. +- Advocating for, or encouraging, any of the above behaviour. + +# Assume Good Intentions # +Give people the benefit of the doubt. If you believe they have acted against the code of conduct, please refer them to this document. Remember, although English is the primary language of Fungus development, that not all members have English as their primary language. + +Thanks to [http://www.apache.org/foundation/policies/conduct.html](http://www.apache.org/foundation/policies/conduct.html) and [https://www.djangoproject.com/conduct](https://www.djangoproject.com/conduct) for inspiration and content. + +If you have any questions about these guidelines please contact us. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9003f992..90ff72c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ We welcome pull requests from everyone. By contributing to this project, you agr Fork and clone the Fungus repo (see [fork a repo] ) +Switch to the develop branch. + Make sure the tests pass locally (see the project readme for instructions). Make your change. Add tests and/or demo scenes for your change. Make the tests pass locally. @@ -19,8 +21,9 @@ Your pull request will have a better chance of being accepted if you do the foll * Write tests for each change / new feature (not always possible) * Follow our [coding standard] * Write a [good commit message][commit]. +* Target and make changes against the develop branch. -[code of conduct]: https://github.com/snozbot/fungus/wiki/code_of_conduct +[code of conduct]: https://github.com/snozbot/fungus/blob/master/CODE_OF_CONDUCT.md [commit]: http://chris.beams.io/posts/git-commit/ [fork a repo]: https://help.github.com/articles/fork-a-repo/ [fungus license]: https://github.com/FungusGames/Fungus/blob/master/LICENSE diff --git a/README.md b/README.md index 19726998..0d034438 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ Support If you have questions about Fungus, please search our forum first as someone may have had the same issue already. If you can't find an answer please start a new discussion and we'll answer you as soon as we can. Fungus is designed for beginners and we love to hear from users so please don't be shy about posting on [the forum](https://fungusgames.com/forum)! +There is also a community run [Discord server](https://discord.gg/99RqraQ). + You can also join into our chat room. [![Join the chat at https://gitter.im/snozbot/fungus](https://badges.gitter.im/snozbot/fungus.svg)](https://gitter.im/snozbot/fungus?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)