-
Notifications
You must be signed in to change notification settings - Fork 13
Development environment
Git- https://www.atlassian.com/git/tutorials/what-is-version-control/
Many exist but a few notables are.
Default CLI - https://git-scm.com/downloads If you are a fan of using command lines, git can be controlled exclusively through CLI.
Github Desktop Client - https://desktop.github.com/ Easy to set up but lacks some advanced features.
SourceTree - https://www.sourcetreeapp.com/ Lots of features and free.
GitKraken - https://www.gitkraken.com/ Visually, as it often describes itself it is "Downright luxurious". However being fairly new as of writing this it has some missing features and is sometimes buggy. Free for open source project usage and cross-platform.
Visual Studio Community Edition - https://www.visualstudio.com/vs/community/ Recommended IDE, Free for open source projects.
Forking(Required) - https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
Before you start committing you will need to make a fork of the main repository (Slivo-fr/EveHQ), This make it so you have free reign over how you commit and manage your version of the codebase then resync in either direction as needed.
GitFlow(Optional) - https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
Base idea of this workflow is to commit all your work initially to feature branches then merge into a development branch once the feature/bugfix is complete.
-To have any changes you have committed to your fork included in the core repository you will need to make a pull request(hearby refrenced as PR).
-All PRs must target the 'Dev' branch.
-Depending on what git client you use the process differs however the base process is...
**1.**Checkout your 'Dev' branch.
**2.**Sync your dev branch by issuing a pull command from (Slivo-fr/EveHQ) dev branch.
**3.**Branch YOU/EveHQ/dev to a YOU/EveHQ/FeatureX
**4.**Add commits directly or through merging other feature branches into it using gitflow.
5.(Optional) If changes have been made to (Slivo-fr/EveHQ) since you last synced, sync again. While this is not strictly required it will ensure that your PR will not have any issues. You may get a merge conflict.
**6.**Push your working branch (YOU/EveHQ/FeatureX) to your fork (YOU/EveHQ).
**7.**Request a PR with (Slivo-fr/EveHQ) dev branch from (YOU/EveHQ) FeatureX branch. If a conflict is detected step 5 becomes a requirement.
Important note: As we start to grow in number of contributors, please work each separate subject on a dedicated branch from your repository and make a single pull request for each single subject/issue mentioning the issue you are solving in the pull request comment
TLDR: Checkout>Pull>Branch>Code&Commit>Push>PullRequest
- Install git client.
- Install Visual Studio.
- Fork repository.
- Clone fork into git client.
- Checkout latest commit on development branch.
- Open project in Visual Studio.
You will have to download the latest SDE data and use the CacheCreator project to generate EveHQ cache file, before running EveHQ itself