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.

Sign up for GitHub

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

Jump to bottom

Improve docs on how to start contributing #1280

Closed
marcelofabri opened this issue Feb 2, 2017 · 6 comments
Closed

Improve docs on how to start contributing #1280

marcelofabri opened this issue Feb 2, 2017 · 6 comments
Labels
enhancement Ideas for improvements of existing features and rules. good first issue Issue to be taken up by new contributors yet unfamiliar with the project. wontfix Issues that became stale and were auto-closed by a bot.

Comments

@marcelofabri
Copy link
Collaborator

#1161 has some useful tips.
@marcelofabri marcelofabri added enhancement Ideas for improvements of existing features and rules. good first issue Issue to be taken up by new contributors yet unfamiliar with the project. labels Feb 2, 2017
@mknabbe
Copy link
Contributor

mknabbe commented Oct 21, 2020

I'd like to get more familiar with the SwiftLint code base and try to do my first contribution by improving the documentation. Is this ticket still valid?

@jpsim
Copy link
Collaborator

jpsim commented Oct 21, 2020

Documentation can always be improved! Maybe you could start by reading #1161 and CONTRIBUTING.md and see what potentially useful information is missing or could be reworded.

@mknabbe
Copy link
Contributor

mknabbe commented Oct 22, 2020

Thanks. I'll have a look.

@mknabbe
Copy link
Contributor

mknabbe commented Oct 24, 2020 •
edited
Loading

I read through the documentation and executed its steps. There's one thing I stumbled upon and it doesn't seem to be documented. It's mentioned in multiple files to fetch the git submodules and I couldn't find the reason for it. The documentation to make changes to the code base uses Swift Package Manager commands. Swift PM doesn't use git submodules as far as I know.
Could someone please explain why forked projects need to fetch the git submodules? I noticed a Carthage setup too. Why those duplication to manage the dependencies?
Thank you in advance.

@jpsim
Copy link
Collaborator

jpsim commented Oct 24, 2020

The git submodules are used when using the Xcode project & workspace (e.g. xed SwiftLint.xcworkspace).

They’re not needed when building using the Swift Package Manager either from the command line or Xcode’s support for it (e.g. xed . or xed Package.swift).

The Carthage setup is used to handle version control for the git submodules. It was also useful at a point in time for consumers of SwiftLintFramework that wanted to integrate it using Carthage.

I would love to remove the git submodule, Cartfile(s) and Xcode workspace+project and only support Swift Package Manager, but before doing that we should check to see if 1) that breaks Carthage users of SwiftLintFramework and/or 2) if there even are any users of SwiftLintFramework using Carthage to see if it’s worth continuing to support them.

mknabbe added a commit to mknabbe/SwiftLint that referenced this issue Oct 27, 2020
@mknabbe @oonoo
Improve "Working Directory" instructions in CONTRIBUTING.md (realm#1280)
eab9285 
The instruction wasn't clear to me and it took me some time to figure out what to insert into the "Working Directory" option.

Co-Authored-By: oonoo <2565796+oonoo@users.noreply.github.com>
mknabbe added a commit to mknabbe/SwiftLint that referenced this issue Oct 27, 2020
@mknabbe @oonoo
Improve "Arguments Passed On Launch" instructions in CONTRIBUTING.md (r…
84023e6 
…ealm#1280)

I wasn't sure which arguments could be passed to SwiftLint. I referenced the Command Line paragraph in the README, it already lists the available arguments.

Co-Authored-By: oonoo <2565796+oonoo@users.noreply.github.com>
mknabbe added a commit to mknabbe/SwiftLint that referenced this issue Oct 27, 2020
@mknabbe
Add more details to "Submodules" in CONTRIBUTING.md (realm#1280)
f697b6f 
The reason to checkout git submodules wasn't mentioned. I added the use cases for submodules, as Swift Package Manager doesn't make use of the git submodules.
mknabbe added a commit to mknabbe/SwiftLint that referenced this issue Oct 27, 2020
@mknabbe
Format "Using Xcode" in CONTRIBUTING.md (realm#1280)
d9cee9e 
Limit line length to 80 characters in "Using Xcode" section of CONTRIBUTING.md.
mknabbe added a commit to mknabbe/SwiftLint that referenced this issue Oct 27, 2020
@mknabbe
Document changes in CHANGELOG.md (realm#1280)
bc69e4d
jpsim added a commit that referenced this issue Oct 27, 2020
@mknabbe @oonoo @jpsim
Improve CONTRIBUTING.md (#3394)
5308e0d 
* Improve "Working Directory" instructions in CONTRIBUTING.md (#1280)

The instruction wasn't clear to me and it took me some time to figure out what to insert into the "Working Directory" option.

Co-Authored-By: oonoo <2565796+oonoo@users.noreply.github.com>

* Improve "Arguments Passed On Launch" instructions in CONTRIBUTING.md (#1280)

I wasn't sure which arguments could be passed to SwiftLint. I referenced the Command Line paragraph in the README, it already lists the available arguments.

Co-Authored-By: oonoo <2565796+oonoo@users.noreply.github.com>

* Add more details to "Submodules" in CONTRIBUTING.md (#1280)

The reason to checkout git submodules wasn't mentioned. I added the use cases for submodules, as Swift Package Manager doesn't make use of the git submodules.

* Format "Using Xcode" in CONTRIBUTING.md (#1280)

Limit line length to 80 characters in "Using Xcode" section of CONTRIBUTING.md.

* Document changes in CHANGELOG.md (#1280)

* Add missing word

Co-authored-by: oonoo <2565796+oonoo@users.noreply.github.com>
Co-authored-by: JP Simard <jp@jpsim.com>
@stale
Copy link

stale bot commented Dec 23, 2020

This issue has been automatically marked as stale because it has not had any recent activity. Please comment to prevent this issue from being closed. Thank you for your contributions!

@stale stale bot added the wontfix Issues that became stale and were auto-closed by a bot. label Dec 23, 2020
@stale stale bot closed this as completed Dec 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Ideas for improvements of existing features and rules. good first issue Issue to be taken up by new contributors yet unfamiliar with the project. wontfix Issues that became stale and were auto-closed by a bot.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jpsim @marcelofabri @mknabbe