Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.44 KB
Raw

Contributing

All contributions are welcome to this project.

Contributor License Agreement

Before a contribution can be merged into this project, please fill out the Contributor License Agreement (CLA). Any new contributor will be prompted to sign this agreement our CLA bot upon creating a pull request.

Development

To contribute to this project we highly recommend reading our guides on making contributions.

  1. Installation & setup
  2. Notes for Box employees
  3. The OpenAPI structure and custom attributes
  4. Adding a new API resource
  5. Base, mini, standard, and full API resources
  6. Adding a new API endpoint
  7. Contributing a pull request
  8. Markdown styleguide
  9. Updating dependencies

Deployment

When pushing to the main or staging branch, GitHub actions will run the linter and tests and will push the compiled OpenAPI spec to the en and en-staging branches respectively.

Translation

On a regular schedule a snapshot of the en branch is created on the en-snapshot branch and imported into our in-house translation system (Moji) and sent off for translation.

Once the translation is completed, the translated content is pushed to the jp branch, which then triggers a rebuild of the Japanese developer documentation.