PLEASE READ: Take care to clean your commits!

[gezobrien]

There's be a few commits recently from various contributors which is great.
However we need to make sure the commits are clean, this commit for example 79e0834 is not clean at all.
It makes over 700 changes to IgeCamera.js.
I have cleaned the commit and removed the junk, the actual differences are
4 line changes, 21 additions.

The indentation of the entire file has been modified, it's very difficult to compare the differences when care is not taken to ensure you are only making the nessesary changes in your commits.

Here's a few things to watch out for.

• Use tabs for indentation, the engine code has always used them, be consistent, dont mix & don't change willy-nilly.
• Line endings, use unix line endings (LF), if your editor doesn't support them, use one that does.
• File encoding, always use utf8.

Please be disiplined. Otherwise your making it incredibly difficult for your fellow contributors to make sense of your changes.

Thanks for reading.

All the best

Rob Aldred

[smileypop]

Hi,

Thank you for the email regarding github. I want to apologize for the
unclean commit. It is my first time contributing on github, and I am
not very familiar with the process. As for the the indentations and
incorrect file encoding, I have been using Webstorm for coding the
game, but it does not allow me to edit the IGE engine files directly
for some reason. I'm not sure if it is a github safety measure or some
option in Webstorm that needs to be switched off. Because of this, I
opened the file in Dreamweaver to make the changes, which resulted in
messing up the file structure. I'm very sorry about this. I appreciate
you bringing it to my attention, and will do my best to make clean
commits in the future.

Kind regards,
Smileypop

Quoting gezobrien [email protected]:

There's be a few commits recently from various contributors which is great.
However we need to make sure the commits are clean, this commit for
example 79e0834 is not clean at all.
It makes over 700 changes to IgeCamera.js.
I have cleaned the commit and removed the junk, the actual differences are
4 line changes, 21 additions.

The indentation of the entire file has been modified, it's very
difficult to compare the differences when care is not taken to
ensure you are only making the nessesary changes in your commits.

Here's a few things to watch out for.

• Use tabs for indentation, the engine code has always used them, be
  consistent, dont mix & don't change willy-nilly.
• Line endings, use unix line endings (LF), if your editor doesn't
  support them, use one that does.
• File encoding, always use utf8.

Please be disiplined. Otherwise your making it incredibly difficult
for your fellow contributors to make sense of your changes.

Thanks for reading.

---

Reply to this email directly or view it on GitHub:
#403

[gezobrien]

Hey Smileypop
Thanks for your message.
It's just general best practice advice for contributors I think. I was merely using your commit as an example, hope you don't think I singled you out. That wasn't my intention at all. :)

I work on Mac so I don't know too much about windows editors unfortunately, although I believe Sublime Text (which i use) is available for windows. I have heard that Webstorm is pretty good with lots of eclipse like functionality. Not sure why it wouldn't be able to edit the Ige files, they are after all just javascript.

I don't know how you manage your commits whether command line or a gui but either way if you just gloss over the diff of changes before you push your commit to github, should be quick to spot instances where unnessesary stuff is being commited

All contributions are very welcome and much appreciated.
So thanks!

Take care
Rob

[smileypop]

It's no problem at all. I'd rather know my mistakes so I can fix them.

I am using Webstorm on Mac. It's a really nice editor and works fine
for Javascript. I think the problem is the Ige files specifically are
read only, although I don't know why. Maybe it has to do with the way
I pulled them in Sourcetree. Again, this is my first time contributing
anything on github, so I've had to learn everything and it's still a
bit confusing. I will pay more attention next time.

Thanks,
Matt

Quoting gezobrien [email protected]:

Hey Smileypop
Thanks for your message.
It's just general best practice advice for contributors I think. I
was merely using your commit as an example, hope you don't think I
singled you out. That wasn't my intention at all. :)

I work on Mac so I don't know too much about windows editors
unfortunately, although I believe Sublime Text (which i use) is
available for windows. I have heard that Webstorm is pretty good
with lots of eclipse like functionality. Not sure why it wouldn't be
able to edit the Ige files, they are after all just javascript.

I don't know how you manage your commits whether command line or a
gui but either way if you just gloss over the diff of changes before
you push your commit to github, should be quick to spot instances
where unnessesary stuff is being commited

All contributions are very welcome and much appreciated.
So thanks!

Take care
Rob

---

Reply to this email directly or view it on GitHub:
#403 (comment)

Kind regards,
Smileypop