Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update gitignore to ignore idea and vscode #160

Merged
merged 1 commit into from
Jul 9, 2021

Conversation

SethFalco
Copy link
Contributor

@SethFalco SethFalco commented Jul 8, 2021

I'm about to rebase and respond to your feedback on #114.
Just wanted to propose some minor changes, though.

.gitignore

  • Ignores all IntelliJ specific files. (What I was using before, so had some files left around still.)
  • Ignores all Visual Studio Code specific files. (What I'm using now.)
  • Replaces the dead link at the top of the file.

Edit: While I was at it, I opted to update the contents of .gitignore with the up-to-date revision on github/gitignore.

I can replace the link with https://raw.githubusercontent.com/github/gitignore/6651bca9c83572f908474fc6206ed8a80df91290/Maven.gitignore if preferred?
I prefer the current link, but whatever suits you.

.editorconfig

For those using code editors like Visual Studio Code, it can be easier if the project defines its preferences using EditorConfig to override any program settings. (a vendor-agnostic configuration file that many code editors support)

I've just taken the EditorConfig configuration from the most starred Java project Apache has on GitHub:
https://github.com/apache/dubbo/blob/3.0/.editorconfig

It could be worth considering if you'd want to change anything about it, for example I think something like this might be better:

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

# Preserve line breaks in Markdown
[*.md]
trim_trailing_whitespace = false

# 4 space indentation
[*.{java,xml}]
indent_size = 4

@SethFalco SethFalco force-pushed the chores branch 2 times, most recently from e5a6543 to 08b373d Compare July 9, 2021 00:06
@coveralls
Copy link

coveralls commented Jul 9, 2021

Coverage Status

Coverage remained the same at 98.31% when pulling 4f442ba on SethFalco:chores into 46bae4b on apache:master.

@garydgregory
Copy link
Member

We don't use editorconfig anywhere in Commons that I'm aware of so let's skip it. If anything , we could store formatting configs for Eclipse, IJ, and so on in src/conf, maybe...

@SethFalco SethFalco changed the title chore: update gitignore and add editorconfig chore: update gitignore to ignore idea and vscode Jul 9, 2021
@SethFalco
Copy link
Contributor Author

SethFalco commented Jul 9, 2021

Just made one more minor edit, sorry!
About to look at my PRs to commons-beanutils again since I left those hanging. ^-^'

Realized the IntelliJ/Eclipse files can be in submodule directories as well. Thought I should update that too.

@garydgregory garydgregory changed the title chore: update gitignore to ignore idea and vscode Update gitignore to ignore idea and vscode Jul 9, 2021
@garydgregory garydgregory merged commit e40f9ac into apache:master Jul 9, 2021
asfgit pushed a commit that referenced this pull request Jul 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants