Skip to content

Commit 238a6a4

Browse files
JooHyukKimcowtowncoder
authored andcommitted
Revert "."
This reverts commit 3f7eafe.
1 parent a9f15cc commit 238a6a4

File tree

122 files changed

+987
-8098
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+987
-8098
lines changed

Acknowledgements-2.12.md

-56
This file was deleted.

CONTRIBUTING.md

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
## Contributing to Jackson
2+
3+
First of all: we would love to get your contributions, whether they are in form of bug reports,
4+
Requests for Enhancement (RFE), documentation, or code patches.
5+
This page lists things that are important to know about contributing to Jackson project repositories.
6+
7+
### Community, Communication
8+
9+
The easiest ways to participate beyond using Jackson is to join one of Jackson mailing lists
10+
(Jackson google groups):
11+
12+
* [Jackson Announce](https://groups.google.com/forum/#!forum/jackson-announce): Announcement-only list for new Jackson releases, meetups and other events related to Jackson
13+
* [Jackson User](https://groups.google.com/forum/#!forum/jackson-user): List dedicated for discussion on Jackson usage
14+
* [Jackson Dev](https://groups.google.com/forum/#!forum/jackson-dev): List for developers of Jackson core components and modules, discussing implementation details, API changes.
15+
16+
or to join chat on
17+
18+
* [Jackson-databind gitter](https://gitter.im/FasterXML/jackson-databind) forum
19+
20+
There are other related lists and forums as well:
21+
22+
* [Smile Format Discussion](https://groups.google.com/forum/#!forum/smile-format-discussion): List for discussing details of the binary JSON format called [Smile](https://en.wikipedia.org/wiki/Smile_%28data_interchange_format%29) (see [Smile Specification](https://github.com/FasterXML/smile-format-specification))
23+
24+
Note that individual Jackson projects have different maintainers; see the individual project
25+
README for the list of maintainers of that module.
26+
27+
<br>
28+
29+
### Issue Tracking
30+
31+
All bug reports, improvements ideas and RFEs are handled as Github Issues using
32+
per-repository Issue Tracker. For example, issues related to Jackson databinding
33+
(main json-to/from-Java objects handling) component would go
34+
to [jackson-databind Issue Tracker](https://github.com/FasterXML/jackson-databind/issues).
35+
36+
#### "New Contributor Friendly" issues
37+
38+
One effort to help new contributors is to try to collect issues that might be particularly good for
39+
new contributors:
40+
41+
[Issues for New Contributors](https://github.com/FasterXML/jackson/wiki/Issues-For-New-Contributors) (Added for Hacktoberfest 2019)
42+
43+
### Code contributions, related
44+
45+
#### Pull Requests
46+
47+
All code contributions are made using Github Pull Requests: you typically fork the component
48+
to modify, and eventually create a Pull Request. It is good to have a Github Issue created
49+
for change you want to submit, explaining what is needed (bug fix, change to behavior,
50+
new feature) although this is not absolutely required.
51+
52+
#### Branches
53+
54+
When creating code (or documentation, test) change for eventual Pull Request, it is important to
55+
understand which Git Branch to use as the base.
56+
57+
Jackson projects maintain a few branches:
58+
59+
* `master` for developing the still-far-off 3.0.0 release -- but is also used for `README.md`s
60+
* `2.16` the next minor version in development
61+
* `2.15` the current stable release
62+
* `2.14` the previous stable branch, for which patch releases are still made
63+
* `2.13` inactive branch that may receive micro-patches for urgent security issues (usually only [`jackson-databind`](https://github.com/FasterXML/jackson-databind))
64+
65+
Most bug-fix Pull Requests should be made against the current stable branch, `2.15`.
66+
Pull requests for major new functionality or that significantly alter internals,
67+
but are backwards-compatible with existing behavior should be made against the next minor version
68+
branch (`2.16`).
69+
If Jackson's functionality or default behavior is to be altered, `master` is the correct branch, but
70+
discussion is probably in order.
71+
72+
If you have any concerns or doubts about branch to use, feel free to reach out on user mailing
73+
list or chat; or even on issue tracker of relevant repository.
74+
75+
#### Backwards Compatibility
76+
77+
When submitting a pull request, your choice of a base branch should take into account backwards
78+
compatibility.
79+
80+
The Jackson project follows [Apache versioning](https://apr.apache.org/versioning.html). Patch
81+
versions maintain source and binary compatibility; functionality may be added, but existing code
82+
that depends upon Jackson must continue to function properly without alteration. Minor versions
83+
add functionality, may deprecate existing functionality, and may remove functionality that has
84+
been deprecated for at least two minor versions. Any changes that require breaking existing
85+
functionality must be part of a major version release.
86+
87+
See [Jackson Releases on the wiki](https://github.com/FasterXML/jackson/wiki/Jackson-Releases)
88+
for more information.
89+
90+
#### Testing
91+
92+
Jackson's functionality is vast and is used widely, so automated testing for any changes is
93+
important for preventing accidental breakage in the future. Tests also document and demonstrate
94+
the bounds of functionality, showing the author's intent to others working on the code in the
95+
future.
96+
97+
#### Paperwork
98+
99+
There is not a lot of paperwork related to code changes: Pull Requests are almost all it takes.
100+
101+
But there is one thing that is needed before development team can accept a code change (exception:
102+
test code changes do not require one):
103+
[Contributor License Agreement (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement).
104+
This is needed before your very first code contribution, but covers all Jackson projects and
105+
will NOT be needed for other future contributions.
106+
107+
All you need to do is to download the CLA document, print it, fill and sign, scan (or take
108+
photo on your phone) and email that copy to `info` at `fasterxml` dot `com`.
109+
110+
As to document to download, you have 2 choices:
111+
112+
* Standard Jackson [Contributor License Agreement](../../blob/master/contributor-agreement.pdf) (CLA) is a one-page document we need from every contributor of code (we will request it for pull requests), used mostly by individual contributors
113+
* [Corporate CLA](../../blob/master/contributor-agreement-corporate.txt) is used by Corporations to avoid individual employees from having to send separate CLAs; it is also favored by corporate IP lawyers.
114+
115+
of which the first option is more commonly used (by over 90% of contributors).
116+
117+
Note that the first option is available for corporations as well, but most companies have opted to use the second option instead. Core team has no preference over which one gets used: both work; we care more about actual contributions.

FAQ.md

-26
This file was deleted.

Home.md

-12
This file was deleted.

Issues-For-New-Contributors.md

-110
This file was deleted.

0 commit comments

Comments
 (0)