Difference between revisions of "Template:Contributing"
From Servarr
| (7 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
=== Tools required === | === Tools required === | ||
| − | + | :* 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) | |
| − | + | :* [https://git-scm.com/downloads Git] | |
| − | + | :* [https://nodejs.org/en/download/ NodeJS] (Node 10.X.X or higher) | |
| − | + | :* [https://yarnpkg.com/ Yarn] | |
| − | + | :* Net 5 SDK | |
=== Getting started === | === Getting started === | ||
| − | + | # Fork {{{ARRNAME}}} | |
| − | + | # 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. | |
| − | + | # Build the project in Visual Studio, Setting startup project to `{{{ARRNAME}}}.Console` and framework to `netcoreapp31` | |
| − | + | # Debug the project in Visual Studio | |
| − | + | # Open http://localhost:{{{ARRPORT}}} | |
=== Contributing Code === | === 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 === | === 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. | If you have any questions about any of this, please let us know. | ||
Latest revision as of 18:16, 27 January 2021
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 VisualStudio. The community version is free and works.
- HTML/Javascript editor of choice (VS Code/Sublime Text/Webstorm/Atom/etc)
- Git
- NodeJS (Node 10.X.X or higher)
- Yarn
- Net 5 SDK
Getting started
- Fork {{{ARRNAME}}}
- Clone the repository into your development machine. *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.
- Build the project in Visual Studio, Setting startup project to `{{{ARRNAME}}}.Console` and framework to `netcoreapp31`
- Debug the project in Visual Studio
- Open http://localhost:{{{ARRPORT}}}
Contributing Code
- If you're adding a new, already requested feature, please comment on 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 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.
