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

Document how we use git and GitHub (and maybe broader engineering guidelines) #22

Open
cpswan opened this issue Aug 5, 2022 · 10 comments
Assignees
Labels
3 SP 3 Story Points - 1 Day Small enhancement New feature or request PR43 Aug 2022 Sprint Planning PR44 Aug 2022 Sprint Planning PR45 Aug | Sept 2022 Sprint Planning PR46 Sept | Oct Sprint Planning PR47 Oct Sprint Planning PR48 Oct 2022 Sprint Planning PR49 Oct | Nov 2022 Sprint Planning

Comments

@cpswan
Copy link
Member

cpswan commented Aug 5, 2022

Is your feature request related to a problem? Please describe.
We're now using a range of GitHub templates, automations, bots, actions etc., which are well understood to those of use who've been around to see them implemented and get involved in the conversations about them. But all this stuff is likely to be confusing to new joiners.

Describe the solution you'd like
Add some READMEs (to a section of this repo or in a new repo) explaining how we use git and GitHub.

Describe alternatives you've considered
We could also broaden this out to cover other aspects of what we expect from engineers to make our engineering culture more explicit.

@cpswan cpswan added the enhancement New feature or request label Aug 5, 2022
@cpswan cpswan assigned gkc and cpswan Aug 5, 2022
@ksanty ksanty added 5 SP 5 Story Points - 3 Days Medium PR43 Aug 2022 Sprint Planning labels Aug 9, 2022
@cpswan
Copy link
Member Author

cpswan commented Aug 17, 2022

Initial document published to https://github.com/atsign-foundation/.github/blob/trunk/atGitHub.md

@cpswan
Copy link
Member Author

cpswan commented Aug 22, 2022

Dropping to 3 SP for remaining work and moving to PR44

@cpswan cpswan added 3 SP 3 Story Points - 1 Day Small and removed 5 SP 5 Story Points - 3 Days Medium labels Aug 22, 2022
@ksanty ksanty added the PR44 Aug 2022 Sprint Planning label Aug 23, 2022
@cpswan
Copy link
Member Author

cpswan commented Sep 5, 2022

No progress on this in PR44, so pushing to PR45

@ksanty ksanty added the PR45 Aug | Sept 2022 Sprint Planning label Sep 6, 2022
@cpswan
Copy link
Member Author

cpswan commented Sep 16, 2022

Again no progress in PR45 so pushing to PR46

@ksanty ksanty added the PR46 Sept | Oct Sprint Planning label Sep 19, 2022
@cpswan
Copy link
Member Author

cpswan commented Oct 3, 2022

Need to get some @gkc bandwidth on this. Bumping to PR47

@ksanty ksanty added the PR47 Oct Sprint Planning label Oct 3, 2022
@gkc
Copy link
Contributor

gkc commented Oct 7, 2022

Other things we might want to cover

  • Ever-increasing platform quality
  • Tests
    • Unit tests vs functional tests vs e2e tests
    • Style guides
  • Code quality
  • Docs quality
  • "You touch it, you tidy it"
  • Backwards and forwards compatibility
  • We need to say something about lints
    • Style guides
  • Automated dependency management
    • If you pull on a thread, you have to go the whole way
  • We want to get chunks of work done but the associated work to sustainably lift the quality also needs to happen
  • This follow-up work needs to get into GH issues
  • Also related to pubspec - clear definition of when we ^ dependencies and when we pin dependencies
  • Substantial overview of what happens in PR reviews - expectations on both sides
  • Engineering task lifecycle/process
  • Need a place to discuss all of this stuff!
  • Anti-patterns

@cpswan
Copy link
Member Author

cpswan commented Oct 17, 2022

Some progress on this in PR47, but section headers need to be fleshed out in PR48

@ksanty ksanty added the PR48 Oct 2022 Sprint Planning label Oct 18, 2022
@cpswan
Copy link
Member Author

cpswan commented Oct 31, 2022

We didn't get to this in PR48, so bumping to PR49

@ksanty ksanty added the PR49 Oct | Nov 2022 Sprint Planning label Nov 1, 2022
@gkc
Copy link
Contributor

gkc commented Nov 13, 2022

Too much other, more pressing, work came up during PR49.

@cpswan
Copy link
Member Author

cpswan commented Nov 14, 2022

Given the volume of stuff on the hoist for PR50 I'm moving this to the backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 SP 3 Story Points - 1 Day Small enhancement New feature or request PR43 Aug 2022 Sprint Planning PR44 Aug 2022 Sprint Planning PR45 Aug | Sept 2022 Sprint Planning PR46 Sept | Oct Sprint Planning PR47 Oct Sprint Planning PR48 Oct 2022 Sprint Planning PR49 Oct | Nov 2022 Sprint Planning
Projects
None yet
Development

No branches or pull requests

3 participants