Opened 3 years ago

Closed 23 months ago

#18730 closed task (implemented)

Provide guidelines for the Metrics Team's Java projects

Reported by: iwakeh Owned by: iwakeh
Priority: Medium Milestone:
Component: Metrics Version:
Severity: Normal Keywords: ctip, metrics-2017
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

This is the parent issue for defining

  • contributor's guidelines
  • coding style guidelines
  • release process description
  • (more?)

for java projects.

This issue serves for discussing "meta" questions like finding a central location and defining the structure.

The central place could be another git repository metrics-team-meta (or some better title), which could hold all documents like coding style guides for the various languages used by the Metrics-Team, guides and documents covering more than one Metrics-Team project, and other docs like the road-map.)

Child Tickets

TicketStatusOwnerSummaryComponent
#18733closediwakehcontributor's guide incl. coding guidelines for java projectsMetrics

Change History (14)

comment:1 Changed 3 years ago by iwakeh

metrics-team meeting result:
the new central git project will have the name metrics-team

comment:2 Changed 3 years ago by iwakeh

The structure needs to be defined still.

  1. simple structure:
    • guides: contains all the guides for all the possible languages. The guides' file names should contain the language.
    • team-docs: for the road-map and the like
  2. more elaborate structure:
    • guides
      • java
      • web
      • <other languages/areas>
    • team docs
      • some sub-structure

Well, currently I think the very simple structure will suffice.
We could restructure when its necessary.

There might be better structures than the two above.
Suggestions?

comment:3 Changed 3 years ago by iwakeh

Status: newneeds_information

comment:4 Changed 3 years ago by karsten

Great question. Can we try to answer that by brainstorming a list of all the things that might go into this repository and then organizing these hypothetical things into a useful structure? I can think of many things I'd want to explain to a new contributor to the metrics team, and maybe you can think of many things you'd have enjoyed reading when you were about to join the team? Maybe our lists mostly overlap, but maybe you come up with different things than I. This could be fun, we could do this on a pad, maybe next Thursday at the same time as we'd usually have the metrics team meeting, and we could invite other metrics team members. What do you think?

Of course, if you'd rather want to keep this simple for now and avoid waiting until next Thursday, please just go ahead and start writing documentation that we'd later sort into a structure. In that case just pick the very simple structure you suggested and don't let me slow you down. :)

comment:5 in reply to:  4 Changed 3 years ago by iwakeh

Replying to karsten:

... Can we try to answer that by brainstorming a list of all the things that might go into this repository and then organizing these hypothetical things into a useful structure? ... This could be fun, we could do this on a pad, maybe next Thursday at the same time as we'd usually have the metrics team meeting, and we could invite other metrics team members. What do you think?

Yes, that's a good start for this! Let's meet Thursday.

comment:6 Changed 3 years ago by karsten

Great, I'll send an announcement to metrics-team@ on Wednesday in case somebody else wants to join us. Let's meet at the usual time and place and then create a new pad for this.

comment:7 Changed 3 years ago by iwakeh

Meeting results can be found here.

comment:8 Changed 3 years ago by iwakeh

Owner: set to iwakeh
Status: needs_informationaccepted

all information was provided, set to accepted.

comment:9 Changed 3 years ago by iwakeh

Component: Metrics/CollecTorMetrics

comment:10 Changed 2 years ago by karsten

Summary: provide guidelines for the Metrics Team's java projectsProvide guidelines for the Metrics Team's Java projects

Capitalize all words in the summary that deserve capitalization.

comment:11 Changed 2 years ago by karsten

Keywords: metrics-2018 added

comment:12 Changed 2 years ago by karsten

Keywords: metrics-2017 added; metrics-2018 removed

comment:13 Changed 23 months ago by iwakeh

I think this is done and we're successfully using the guide docs.

Describing the release process is a different ticket #18732.

All done. -> Closing.
Thanks!

comment:14 Changed 23 months ago by iwakeh

Resolution: implemented
Status: acceptedclosed
Note: See TracTickets for help on using tickets.