Development setup

Trevan

Also, is the SSH key required? I haven't done much with Github before, but I have never needed an SSH key for any of it. So i guess the question is, is that a TripleA project thing? or a Github thing that I never got to the point of using?

SSH key is not required. It is one of the ways to authenticate in git. But if you use the https protocol, that will work.

ff03k64

@Trevan Okay, i like that better. What is the best way to clone a project? Via the browser or the desktop app?

Trevan

@ff03k64 said in Development setup:

@Trevan Okay, i like that better. What is the best way to clone a project? Via the browser or the desktop app?

There really isn't a best way. It is up to your preference. Since you are using Eclipse, I think it has built in git functionality so you might use that.

ff03k64

I am trying to clone it in Eclipse, but it isn't seeming to work for me. What are the advantages of intellij?

Trevan

IntelliJ vs Eclipse is a preference thing. I use IntelliJ at work so I'm more used to it compared to Eclipse.

LaFayette

SSH key replaces username and password combination. It is strongly recommended, otherwise you'll be typing your username and password repeatedly. Before any time you start coding, you should always update your source code to match the latest, this requires an authentication, similar if you push code.
IntelliJ vs Eclipse is preference, though I think in part it's familiarity too. It's difficult to transition IDE and not being familiar with a new one makes it seem inferior.

My 2 cents, Eclipse was a best in class for a long time but became too much of a 'platform' and around 2015 lost its position. Intellij is not as old and its development has out-paced eclipse IMO quite a bit and continues . Intellij is now winning "the battle" decisively: https://snyk.io/blog/intellij-idea-dominates-the-ide-market-with-62-adoption-among-jvm-developers/. I transitioned a few years ago after being a long-time eclipse user and have been happy with IDEA.

Re: git commands, I generally use terminal for all git commands. You can use the built-in commands of either IDE or go with something like 'sourcetree'. IMO there is no replacement for git CLI, though it does have a learning curve.

ff03k64

Trying to setup intellij now. Neither document is particularly good for a relative newb to this.
What is the file i am suppose to select for this line? https://github.com/triplea-game/triplea/blob/master/docs/development/ide-setup/intellij-setup.md

heckstyle-IDEA plugin

    after install finish configuration in: Other Settings > Checkstyle
    select checkstyle file:

is it part of the settings down below it on that page that i import?

And the following line makes zero sense to me.

Save Actions
    configure in settings to add 'final' to local variables and class variables.

Trevan

@ff03k64 I don't have anything in "Other Settings > Checkstyle" so I'm not sure what that line is referencing.

For the "Save Actions", you need to install the "Save Actions" plugins. Once it is installed, go to "Other Settings > Save Actions" and check the "Add final modifier to local variable or parameter except if it is implicit". The line has changed since that document was created. You should try creating a PR with changes for this document. That would be a good first PR to attempt.

ff03k64

@Trevan I can't select that setting. In order to select it, i have to activate save actions in some way. There are 3 options, on save, on shortcut, and on batch. Which one do i want?

Thanks!

Trevan

@ff03k64 I use "on save".

ff03k64

@Trevan That was my default thought, thanks. I will try to use it as my first PR as well. Now that i have an idea of what to do.

ff03k64

@Trevan Do you have a good intellij guide i can use? Just trying to do simple things, like making this page have numbers instead of bullets. Just something simple. But it doesn't like that new formatting unless I add <br> to the end of each line. I think it is trying to be guess what i want it to do, but it is failing on this one.

Trevan

@ff03k64 That's a markdown file so make sure you are using markdown syntax. A basic syntax guide for markdown can be found at https://www.markdownguide.org/basic-syntax/.

ff03k64

@Trevan I will take a look, thanks!

ff03k64

Is there any documentation for creating a pull request?

Trevan

https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork is some documentation on creating a PR.

You first need to fork triplea-game. Then you'll clone it locally. You'll create a branch to make your changes and then commit them. Then, you'll push your changes to your fork on github. At that point, if you browse to https://github.com/triplea-game/triplea/pulls, you'll see a message in the top half of the page saying that you have a branch that can be made into a PR. That message has a button that you can click on and it will take you to the PR page where there are some questions for you to fill out. Once you are done with that, you can submit it and the PR will be created.

ff03k64

@Trevan How do i keep my fork up to date?

I managed to make a commit to my own fork on github so i am one commit ahead (which i assume is what i will want to make a PR with when i get that far), but it says that i am 11 commits behind the triplea-game:master. I am sure it isn't relevant to any of my changes, but figured if i progress with this, it will be eventually.

Trevan

@ff03k64 I only know how to keep the github fork up to date using the command line. There might be a way to do it inside of IntelliJ or some other UI but here's what you do with the command line.

In the cloned directory on your system, run the command:

git remote -vv

That should show something like:

origin	git@github.com:trevan/triplea.git (fetch)
origin	git@github.com:trevan/triplea.git (push)

That allows you to pull/push to your fork in github.
You need to add a new "remote" that is pointing to the triplea-game repo in github so that you can grab new changes. To do that, run on of the following commands:

(for https)
git remote add upstream https://github.com/triplea-game/triplea.git
(for git)
git remote add upstream git@github.com:triplea-game/triplea.git

Now, to update the "master" branch of your fork, you need to first check it out.

git checkout master

Then you need to fetch the latest information from triplea-game:

git fetch upstream

Then you need to "rebase" your master on top of triplea-game.

git rebase upstream/master

Then you need to push master to your fork

git push master

When you create new branches to do development, you should make sure your local "master" has been rebased with the latest from upstream.

ff03k64

@Trevan
Thanks some more! While searching around for stuff on the website, I think I found a way to do it there too.

Since I decided that my first PR would be that documentation, how would I put I screenshot there? I think I uploaded it to files on github, but now I can't find it to get a link.

Trevan

@ff03k64 Here's gist on how to upload a file to github and get a url that you can add it to the markdown file: https://gist.github.com/vinkla/dca76249ba6b73c5dd66a4e986df4c8d