Anyone interesting in writing `CONTRIBUTING.md` for Jackson?

8 views
Skip to first unread message

Tatu Saloranta

unread,
May 5, 2020, 8:23:26 PM5/5/20
to jacks...@googlegroups.com
I was reminded that one small but important/useful thing Jackson repos
are still missing is a brief description of how to start contributing
things to Jackson; typically added as `CONTRIBUTING.md` page.
This could go under Jackson portal repo
(https://github.com/FasterXML/jackson) and then linked to from other
repos.

Portal has some of the information already, and I can try writing one
myself if no one else feels like doing it -- but I think there are
probably better wordsmiths around than me.
I would be particularly interested in finding out things to add that I
wouldn't think of (since I know the project too well, basically).

Anyone interested in doing / helping this?

I assume basic things would include:

1. Resources for contacting maintainers (google groups, gitter)
2. Something about branches
3. Need for CLA before first contribution (but maintainers will ask
for one when necessary)
4. Importance of simple test(s) for covering change
5. Something about backwards compatibility

but I am sure there are many other things to mention too...

-+ Tatu +-

Drew Stephens

unread,
May 6, 2020, 9:57:15 AM5/6/20
to jackson-dev
I'll get something started; expect a draft PR in the next few days.

-Drew

Tatu Saloranta

unread,
May 6, 2020, 3:20:47 PM5/6/20
to jacks...@googlegroups.com
Much appreciated! I hope others can chime in with comments on PR; that
is probably a good way to get more collaboration.

-+ Tatu +-
> --
> You received this message because you are subscribed to the Google Groups "jackson-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to jackson-dev...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/jackson-dev/4660e2e6-d562-4ffd-a275-5ffe6813f77c%40googlegroups.com.

Drew Stephens

unread,
May 8, 2020, 5:00:09 PM5/8/20
to jackson-dev

Pulled some stuff out of the README and linked to CONTRIBUTING.
Haven't written the tests section yet.

-Drew
> To unsubscribe from this group and stop receiving emails from it, send an email to jacks...@googlegroups.com.

Tatu Saloranta

unread,
May 11, 2020, 6:48:35 PM5/11/20
to jacks...@googlegroups.com
I really like the resulting version, just merged. Thank you!

-+ Tatu +-
> To unsubscribe from this group and stop receiving emails from it, send an email to jackson-dev...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/jackson-dev/7cd46f28-67c1-4f5c-b40e-f152be97c97e%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages