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

Add GOALS file, to define 1.0. #335

Closed
wants to merge 1 commit into from
Closed

Add GOALS file, to define 1.0. #335

wants to merge 1 commit into from

Conversation

georgebrock
Copy link
Collaborator

@georgebrock georgebrock commented Nov 21, 2018

What's left to do before we can call this 1.0?

@georgebrock
Copy link
Collaborator Author

This was inspired by a Slack conversation about versioning, and https://github.com/thoughtbot/terrapin/blob/master/GOALS

A lot of these things are described in more detail in GitHub issues, so maybe a GitHub Milestone would be a better place to put this?

Copy link
Contributor

@mike-burns mike-burns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!


[x] it provides a useful interactive shell environment.
[x] it runs scripts.
[ ] it has the kinds of features expected by advanced shell users.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a bit vague. Should this have examples?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking of these features: #321, #325, #145, #100, #67, and maybe also #303, #41, #35

Not sure if it's redundant to list them out here and in GitHub issues? I could also imagine someone suggesting a very reasonable feature that fits in this list and seems like it should be in 1.0, but maybe I should resist that kind of feature creep.

[x] it runs scripts.
[ ] it has the kinds of features expected by advanced shell users.
[ ] its tab completion system is at least as good as Git's bash integration.
[ ] it has a smooth install process on popular versions of macOS, BSD and GNU/Linux.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to help with this!

gitsh hits 1.0 when:

[x] it provides a useful interactive shell environment.
[x] it runs scripts.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is done, should this be a bit more descriptive?

@mike-burns
Copy link
Contributor

Yeah or maybe a GH Issue Project?

In a Slack thread I listed these advantages:

  • give everyone an indication of what it means for them to use a sub-1.0 project.
  • give me a clear indication of when I've hit 1.0, so I won't run into perfectionism stopping me.
  • help me get to 1.0 ASAP, so we can get normal semver going.

@georgebrock
Copy link
Collaborator Author

After the conversations here about repeating issues in a GOALS file, I set up a couple of issue milestones: https://github.com/thoughtbot/gitsh/milestones

I think these do the same job, although maybe the should be referenced in the contributing guide.

@mike-burns
Copy link
Contributor

Oh that's great. LGTM. I guess you'd close this?

@georgebrock
Copy link
Collaborator Author

Yep, closing this in favour of GitHub milestones.

@georgebrock georgebrock deleted the goals branch February 10, 2019 17:04
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

Successfully merging this pull request may close these issues.

None yet

3 participants