Skip to content

Conversation

@chshersh
Copy link
Owner

@chshersh chshersh commented Feb 3, 2025

Adding some guidelines for ensuring we don't stress from working on this project (stressing out about breaking the rules doesn't count).

TL;DR: Be respectful, behave like an adult and prefer discussing issues first to avoid conflicts and unexpected ambiguity.

Please, read it and let me know if the wording doesn't make sense or if something is unclear.

cc @heathhenley @thezbm @loadre @qexat since you contributed in the past and may want to contribute in the future

I'll keep this PR open for 1 week to give you folks some time to review and discuss, and then I'll merge it on February 9th.


As for long-term goals, I plan to work on this project today, tomorrow, in one week, in one month and this year. Then we'll see.

Maybe Microsoft will recognise this wholesome effort and pay me huge bucks. But to be realistic, most likely, people will try GitHub TUI and just start constantly complaining a lot about something not working.

My plan is to make the 1.0 release this year (see milestones for the roadmap).

  • The 1.0~alpha release is just barely useable with minimal features (viewing issues, PRs, reading, replying).
  • The 1.0~beta release is to ensure stability and fix corner cases
  • The final 1.0 release is announcing beta, letting people try and fix all bugs that come afterwards

The current stage is pre-alpha. I'll continue to exercise my power of BDFL and push to main directly until alpha is done. Obviously, I'll be reasonable to avoid conflicts with current PRs.

Then, I'll slow down and start working through PRs (if we still have contributors who can review the code).

Happy to discuss further!

@chshersh chshersh added component: documentation Improvements or additions to documentation type: feature New feature request priority: high Issues with high priority, should addressed sooner than anything else labels Feb 3, 2025
@chshersh chshersh requested review from heathhenley and qexat February 3, 2025 21:09
@chshersh chshersh self-assigned this Feb 3, 2025
Copy link
Collaborator

@heathhenley heathhenley left a comment

Choose a reason for hiding this comment

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

Looks great!

Copy link
Collaborator

@qexat qexat left a comment

Choose a reason for hiding this comment

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

looks good to me!
I wonder if we need some dev notes for non-code things that might not be obvious when hacking on this project?

edit: ignore my question :P

@heathhenley
Copy link
Collaborator

heathhenley commented Feb 3, 2025

looks good to me! I wonder if we need some dev notes for non-code things that might not be obvious when hacking on this project?

What kind of things do you mean here?

@qexat
Copy link
Collaborator

qexat commented Feb 3, 2025

@heathhenley actually nevermind I just noticed that what I thought about was already in the README 😌

@loadre
Copy link
Contributor

loadre commented Feb 4, 2025

Looks good to me! 👍

@thezbm
Copy link
Collaborator

thezbm commented Feb 4, 2025

Looks good to me 🚀

@chshersh
Copy link
Owner Author

chshersh commented Feb 4, 2025

Thanks everyone for the quick review!

Since we got approvals from everyone, I'll merge it earlier.

There's always a possibility to discuss and change it later if anything comes up.

@chshersh chshersh merged commit c3f5cd9 into main Feb 4, 2025
3 checks passed
@chshersh chshersh deleted the chshersh/contributing branch February 4, 2025 07:45

That's all so far!

> ![NOTE]
Copy link
Collaborator

Choose a reason for hiding this comment

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

should be [!NOTE]

Copy link
Owner Author

Choose a reason for hiding this comment

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

Mistakes were made 🫠

Copy link
Owner Author

Choose a reason for hiding this comment

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

Thanks again for noticing! Done in 8369e37

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: documentation Improvements or additions to documentation priority: high Issues with high priority, should addressed sooner than anything else type: feature New feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants