shen/lightweight-charts
1
0
Fork 0
mirror of https://github.com/tradingview/lightweight-charts.git synced 2024-11-25 16:50:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
lightweight-charts/CONTRIBUTING.md
Mark Silverwood bb8ff6850f add trademark symbols to Lightweight Charts™
2023-03-21 10:32:33 +00:00

2.4 KiB
Raw Permalink Blame History

Contributing to Lightweight Charts™

Issues

Search for duplicates

Search the existing issues before logging a new one.

Don't restrict your search to only open issues. An issue with a title similar to yours may have been closed as a duplicate of one with a less-findable title.

Filing an Issue

When logging a bug, please be sure to include the following:

  • What version of the library you're using.

  • If at all possible, an isolated way to reproduce the behavior.

  • The behavior you expect to see, and the actual behavior (e.g. screenshots).

  • Make sure the issue title is understandable and searchable.

    Bad: Oh my god! This goddamn thing just blew up! Is that my torn off finger laying out there? Oh my freaking god!

    Good: ACME graphics card overheats and causes injuries when using the software

Pull Requests

  • Outside contributors may implement enhancement/features only after an approval (label "help wanted") by Lightweight Charts™ project maintainers.

  • For build instructions/suggestions see BUILDING.md.

  • After the review process has started, please don't use rebase to update the branch, use merge instead.

    It's hard to track down the changes you made in previous commits if you do rebasing (and even determine if you really changed something).

Tests

  1. Every pull request should have an adequate tests whenever it's possible (we have several type of tests, so you can find what works best for your changes).
  2. If your changes affect painting, then your changes should contain a test case (or test cases) for graphics tests.
  3. Your pull request should pass CI (except checks marked as "not required" - in this case a reviewer should pay attention to job's artifacts).

Git commit messages

  1. Please make sure that every your commit has a clear commit message (not just fix bug or something like this - describe what has been changed/fixed).

  2. If your commit addresses a GitHub issue, feel free to add it somehow:

    • Fixed bug in the method getFoo #42

    • Fixed bug with ... (fixes #42)

    •   Fixed bug with rendering

  See LINK_TO_COMMENT

  3. Useful links: