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

Fork request: AtomLinter/linter-shellcheck #2

Closed
ottok opened this issue Dec 28, 2023 · 6 comments
Closed

Fork request: AtomLinter/linter-shellcheck #2

ottok opened this issue Dec 28, 2023 · 6 comments

Comments

@ottok
Copy link

ottok commented Dec 28, 2023

Hi!

The package https://web.pulsar-edit.dev/packages/linter-shellcheck has 137k+ downloads and 280 stars at https://github.com/AtomLinter/linter-shellcheck.

As it is under the AtomLinter org, it has been frozen, and I hereby request it to be forked to the Pulsar Cooperative org following principles outlined at https://github.com/pulsar-cooperative/.github/blob/72a5697835ab1997c10a91c1abba7add1b3ff771/README.md and https://github.com/pulsar-cooperative/.github/blob/72a5697835ab1997c10a91c1abba7add1b3ff771/guides/fork-new-package.md.

I would personally want to fix the bug AtomLinter/linter-shellcheck#150 but since there is no active 'upstream', contributing is hard, and having this package have a new home at the Pulsar Cooperative would enable effective cooperation for the plugin.

Following the new package doc above, the new name should probably be 'linter-shellcheck-pulsar'.

I also use a bunch of other linters from AtomLinter and might request forking them in the future too.

@confused-Techie
Copy link
Contributor

Thanks a ton for contributing here!

Glad to see the request, and I'm totally on board myself.

As this is now the first community requested fork for this repo, I'm talking with some of the other admins to see if we want to have some sort of poll/vote for forking new packages that meet our requirements, or if it'll be handled more as a do-ocracy.

So I'll get back to you as soon as possible with details!

@confused-Techie
Copy link
Contributor

The repo is now live and forked! pulsar-cooperative/linter-shellcheck-pulsar.

One thing to keep in mind, I've purposefully not published this package yet to the Pulsar Package Registry, as the package is broken, and has failed all tests, and doesn't seem able to startup properly. So it seems the package is broken, and we wouldn't want to publish a known-bad package, until that is fixed.

So thanks again for contributing, and I hope to see the community step in soon to contribute to this new addition!

@confused-Techie
Copy link
Contributor

Actually an update here, via pulsar-cooperative/linter-shellcheck-pulsar#3 I've fixed the testing errors, and seems the errors stemmed from two things:

  • The package getting important config values using the old package name, which has now been rebranded
  • The package expected exact string returns from shellcheck which have changed in some versions.

Those issues have been addressed, all tests are passing, and the package is now successfully published!

@ottok
Copy link
Author

ottok commented Dec 31, 2023

Thanks!

I switched to using the fork now, did basic testing and seems everything works. The old plugin had 137k downloads. Let's see how this one will gain popularity over time :)

image

@ottok
Copy link
Author

ottok commented Dec 31, 2023

I also filed koalaman/shellcheck#2892 to get "upstream" to link to this new plugin instead of the archived old one.

Forking this linter-spellcheck was a good test of how the forking process works. Anyone wanting to repeat this could just look what you in https://github.com/pulsar-cooperative/linter-shellcheck-pulsar/commits/master/ - however in practice it is now a bit difficult to read 13 commits that edited 3 files...

The guide https://github.com/pulsar-cooperative/.github/blob/main/CONTRIBUTING.md is very strict about commits:

While you develop the package and work on bug fixes, please ensure that you use Conventional Commits in your commit messages. This is how new versions of the package's are released and updated. Failing to follow conventional commits within your PR may mean it will be closed without being merged.

Just as constructive feedback I feel I need to point out that you failed to follow this yourself. You should have had one single commit titled 'feat!: Rebrand plugin after forking to Pulsar Cooperative' in one single Pull Request and polish it until it passes the CI. Such a commit is atomic, follows the Conventional Commits, and is what you want contributors to submit to you as well, right?

Build a healthy community by setting good examples in your work and leading with examples.

@ottok
Copy link
Author

ottok commented Feb 3, 2024

Shellcheck just merged koalaman/shellcheck#2892 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants