Skip to content
This repository has been archived by the owner on Sep 22, 2023. It is now read-only.

Latest commit

 

History

History
40 lines (26 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.36 KB

Contributing to Amplitude Developer docs

We welcome contributions from partners and users.

Getting started

For Partners


More information is coming soon!

For users


If you are making substantial updates, read our style guide and formatting cheatsheet before starting work. When you're ready, open a PR.

For Ampliteers


  • To get started with contributing, check out the Developer Docs Confluence site. There, you'll find more conceptual content and important information about contributing.
  • If you're working on a feature that hasn't been announced yet, do your work in the amp-internal-dev repo. When you're ready to ship, open a PR against main. Learn more in Confluence.
  • This is an open source project! Before you push, make sure you haven't committed any sensitive information, including test account API keys or other credentials. It's hard to undo this kind of mistake, so if you accidentally push sensitive info, consider it compromised. Check the Developer Docs Confluence site for next steps.
  • If you have questions or need any help getting started, reach out in #dev-doc-requests.
  • Use a doc template to get started fast:

How long will it take to get your PR merged?

It depends. We have a small documentation team. Someone will acknowledge your PR within a week and can give you a better idea of how long it will take to get merged.

FAQ

  1. Spell Checker is flagging a word as misspelled and I believe it is a mistake. How can I move forward?

Spell Checker detects misspelled words and prevents a pull requests from getting merged. The spell checker may not know brand names, industry jargons, abbreviations to name a few. If you believe that the spell checker is incorrectly flagging a word as misspelled, please add the word to cspellignore.txt.