Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 2.14 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

22 lines (17 loc) · 2.14 KB

Thanks for your interest in plotly.js!

Translations:

  • Please @ mention a few other speakers of this language who can help review your translations.
  • If you've omitted any keys from dist/translation_keys.txt - which means they will fall back on the US English text - just make a short comment about why in the PR description: the English text works fine in your language, or you would like someone else to help translating those, or whatever the reason.
  • You should only update files in lib/locales/, not those in dist/

Features, Bug fixes, and others:

Before opening a pull request, developer should:

  1. make sure they are not on the master branch of their fork as using master for a pull request would make it difficult to fetch upstream changes.
  2. fetch latest changes from upstream/master into your fork i.e. origin/master then pull origin/master from you local master.
  3. then git rebase master their local dev branch off the latest master which should be sync with upstream/master at this time.
  4. make sure to not git add the dist/ folder (the dist/ is updated only on version bumps).
  5. make sure to commit changes to the package-lock.json file (if any new dependency required).
  6. provide a title and write an overview of what the PR attempts to do with a link to the issue they are trying to address.
  7. select the Allow edits from maintainers option (see this article for more details).

After opening a pull request, developer:

  • should create a new small markdown log file using the PR number e.g. 1010_fix.md or 1010_add.md inside draftlogs folder as described in this README, commit it and push.
  • should not force push (i.e. git push -f) to remote branches associated with opened pull requests. Force pushes make it hard for maintainers to keep track of updates. Therefore, if required, please fetch upstream/master and "merge" with master instead of "rebase".