Skip to content

Latest commit

 

History

History
42 lines (20 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

42 lines (20 loc) · 1.85 KB

How to contribute to JPMC projects

We welcome your patches and enhancements to our projects. We have a few basic conditions for contributing below.

Contributor Agreements

We require all contributors to JPMC projects to complete our Contribution Licence Agreement (CLA). You can sign as an individual or as representing your company. You only need to do this once and it covers all current and future projects managed under our GitHub organization.

The contribution agreement can be found here JPMC CLA, follow the instructions to complete and return via email.

Code of Conduct

JPMC's Open Source Project operate under our Code of Conduct helping us maintain inclusive, healthy, and constructive communities

Code Reviews

All submission to projects from any source require code review by project maintainers. We are using GitHub pull requests to enforce code reviews. For more information on GitHub pull requests see GitHub docs

Open Source @ JPMorgan Chase

Contributing to ADkit

Contributing to ADkit is simple.

  1. Clone the code from Github.
  2. Follow the README instructions to create your development environment.
  3. Implement your proposal on a new branch named as "feature/x", where x is your branch name.
  4. Once ready, create a pull request and invite reviewers to take a look.
  5. Once everybody is happy and approves, you can merge your work into ADKit!

Tips to make your life easier.

Take a look at the style of existing code, e.g., variable typing, doctext, and try to use a similar style.

We also would like the test coverage and code quality of ADKit to improve over time, so it pays to break down your code into small parts and then add tests for those parts in /tests.