Template:Contributing - Revision history

Drazzilb at 18:16, 27 January 2021

2021-01-27T18:16:43Z

Drazzilb at 03:40, 1 January 2021

2021-01-01T03:40:04Z

Drazzilb at 03:34, 1 January 2021

2021-01-01T03:34:55Z

Drazzilb: Drazzilb moved page Contributing to Template:Contributing without leaving a redirect: Made into a template

2021-01-01T03:24:55Z

Drazzilb moved page Contributing to Template:Contributing without leaving a redirect: Made into a template

Drazzilb at 03:20, 1 January 2021

2021-01-01T03:20:28Z

Drazzilb at 03:18, 1 January 2021

2021-01-01T03:18:43Z

Drazzilb at 03:16, 1 January 2021

2021-01-01T03:16:05Z

Drazzilb at 03:13, 1 January 2021

2021-01-01T03:13:27Z

Drazzilb at 03:11, 1 January 2021

2021-01-01T03:11:27Z

Drazzilb: Created page with "== How to Contribute == We're always looking for people to help make {{{ARRNAME}}} even better, there are a number of ways to contribute. == Documentation == Setup guides, F..."

2021-01-01T03:07:26Z

Created page with "== How to Contribute == We're always looking for people to help make {{{ARRNAME}}} even better, there are a number of ways to contribute. == Documentation == Setup guides, F..."

New page

== How to Contribute ==

We're always looking for people to help make {{{ARRNAME}}} even better, there are a number of ways to contribute.

== Documentation ==
Setup guides, FAQ, the more information we have on the [[{{{ARRNAME}}}|wiki]] the better please contact one of Team {{{ARRNAME}}} for assistance with getting set up with the wiki.

== Development ==

=== Tools required ===
- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/).
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
- [https://git-scm.com/downloads Git]
- [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher)
- [https://yarnpkg.com/ Yarn]
- .NET Core 3.1.

=== Getting started ===

1. Fork {{{ARRNAME}}}
2. Clone the repository into your development machine. [https://help.github.com/articles/working-with-repositories *info*]
3. Install the required Node Packages `yarn install`
4. Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
5. Build the project in Visual Studio, Setting startup project to `{{{ARRNAME}}}.Console` and framework to `netcoreapp31`
6. Debug the project in Visual Studio
7. Open http://localhost:7878

### Contributing Code ###
- If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)
- Rebase from {{{ARRNAME}}}'s develop branch, don't merge
- Make meaningful commits, or squash them
- Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements
- Reach out to us on the discord if you have any questions
- Add tests (unit/integration)
- Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
- One feature/bug fix per pull request to keep things clean and easy to understand
- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge)

### Pull Requesting ###
- Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it
- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
- We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
- Each PR should come from its own [http://martinfowler.com/bliki/FeatureBranch.html feature branch] not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
- new-feature (Good)
- fix-bug (Good)
- patch (Bad)
- develop (Bad)

If you have any questions about any of this, please let us know.

@@ Line 14: / Line 14: @@
 :* [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher)
 :* [https://yarnpkg.com/ Yarn]
-:* .NET Core 3.1.
+:* Net 5 SDK
 === Getting started ===

@@ Line 19: / Line 19: @@
 # Fork {{{ARRNAME}}}
-# Clone the repository into your development machine. [https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/quickstarts *info*]
+# Clone the repository into your development machine. [https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github *info*]
 # Install the required Node Packages `yarn install`
 # Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
@@ Line 27: / Line 27: @@
 === Contributing Code ===
-:* If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)<br>
+:* If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)
 :* Rebase from {{{ARRNAME}}}'s develop branch, don't merge
 :* Make meaningful commits, or squash them

@@ Line 19: / Line 19: @@
 # Fork {{{ARRNAME}}}
-# Clone the repository into your development machine. [https://help.github.com/articles/working-with-repositories *info*]
+# Clone the repository into your development machine. [https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/quickstarts *info*]
 # Install the required Node Packages `yarn install`
 # Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.

@@ Line 9: / Line 9: @@
 === Tools required ===
-:* Visual Studio 2019 or higher (https://www.visualstudio.com/vs/).  The community version is free and works (https://www.visualstudio.com/downloads/). <br>
+:* Visual Studio 2019 or higher [https://www.visualstudio.com/vs/ VisualStudio].  The [https://www.visualstudio.com/downloads/ community version] is free and works.
-:* HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc) <br>
+:* HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
-:* [https://git-scm.com/downloads Git] <br>
+:* [https://git-scm.com/downloads Git]
-:* [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher) <br>
+:* [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher)
-:* [https://yarnpkg.com/ Yarn] <br>
+:* [https://yarnpkg.com/ Yarn]
-:* .NET Core 3.1.  <br>
+:* .NET Core 3.1.
 === Getting started ===
@@ Line 28: / Line 28: @@
 === Contributing Code ===
 :* If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)<br>
-:* Rebase from {{{ARRNAME}}}'s develop branch, don't merge <br>
+:* Rebase from {{{ARRNAME}}}'s develop branch, don't merge
-:* Make meaningful commits, or squash them <br>
+:* Make meaningful commits, or squash them
-:* Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements <br>
+:* Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements
-:* Reach out to us on the discord if you have any questions <br>
+:* Reach out to us on the discord if you have any questions
-:* Add tests (unit/integration) <br>
+:* Add tests (unit/integration)
-:* Commit with *nix line endings for consistency (We checkout Windows and commit *nix) <br>
+:* Commit with *nix line endings for consistency (We checkout Windows and commit *nix)
-:* One feature/bug fix per pull request to keep things clean and easy to understand <br>
+:* One feature/bug fix per pull request to keep things clean and easy to understand
-:* Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge) <br>
+:* Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge)
 === Pull Requesting ===
-:* Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it <br>
+:* Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it
-:* You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability <br>
+:* You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
-:* We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it <br>
+:* We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it
-:* Each PR should come from its own [http://martinfowler.com/bliki/FeatureBranch.html feature branch] not develop in your fork, it should have a meaningful branch name (what is being added/fixed) <br>
+:* Each PR should come from its own [http://martinfowler.com/bliki/FeatureBranch.html feature branch] not develop in your fork, it should have a meaningful branch name (what is being added/fixed)
      - new-feature (Good)
      - fix-bug (Good)

@@ Line 9: / Line 9: @@
 === Tools required ===
-- Visual Studio 2019 or higher (https://www.visualstudio.com/vs/).  The community version is free and works (https://www.visualstudio.com/downloads/). <br>
+:* Visual Studio 2019 or higher (https://www.visualstudio.com/vs/).  The community version is free and works (https://www.visualstudio.com/downloads/). <br>
-- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc) <br>
+:* HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc) <br>
-- [https://git-scm.com/downloads Git] <br>
+:* [https://git-scm.com/downloads Git] <br>
-- [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher) <br>
+:* [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher) <br>
-- [https://yarnpkg.com/ Yarn] <br>
+:* [https://yarnpkg.com/ Yarn] <br>
-- .NET Core 3.1.  <br>
+:* .NET Core 3.1.  <br>
 === Getting started ===
@@ Line 27: / Line 27: @@
 === Contributing Code ===
-- If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)<br>
+:* If you're adding a new, already requested feature, please comment on [https://github.com/{{{ARRNAME}}}/{{{ARRNAME}}}/issues Github Issues] so work is not duplicated (If you want to add something not already on there, please talk to us first)<br>
-- Rebase from {{{ARRNAME}}}'s develop branch, don't merge <br>
+:* Rebase from {{{ARRNAME}}}'s develop branch, don't merge <br>
-- Make meaningful commits, or squash them <br>
+:* Make meaningful commits, or squash them <br>
-- Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements <br>
+:* Feel free to make a pull request before work is complete, this will let us see where its at and make comments/suggest improvements <br>
-- Reach out to us on the discord if you have any questions <br>
+:* Reach out to us on the discord if you have any questions <br>
-- Add tests (unit/integration) <br>
+:* Add tests (unit/integration) <br>
-- Commit with *nix line endings for consistency (We checkout Windows and commit *nix) <br>
+:* Commit with *nix line endings for consistency (We checkout Windows and commit *nix) <br>
-- One feature/bug fix per pull request to keep things clean and easy to understand <br>
+:* One feature/bug fix per pull request to keep things clean and easy to understand <br>
-- Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge) <br>
+:* Use 4 spaces instead of tabs, this is the default for VS 2019 and WebStorm (to my knowledge) <br>
 === Pull Requesting ===
-- Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it <br>
+:* Only make pull requests to develop, never master, if you make a PR to master we'll comment on it and close it <br>
-- You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability <br>
+:* You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability <br>
-- We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it <br>
+:* We'll try to respond to pull requests as soon as possible, if its been a day or two, please reach out to us, we may have missed it <br>
-- Each PR should come from its own [http://martinfowler.com/bliki/FeatureBranch.html feature branch] not develop in your fork, it should have a meaningful branch name (what is being added/fixed) <br>
+:* Each PR should come from its own [http://martinfowler.com/bliki/FeatureBranch.html feature branch] not develop in your fork, it should have a meaningful branch name (what is being added/fixed) <br>
      - new-feature (Good)
      - fix-bug (Good)