Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up CONTRIBUTING.md #5911

Merged
merged 2 commits into from
Sep 19, 2018
Merged

Conversation

alekstorm
Copy link
Contributor

CONTRIBUTING.md is so large it's hard to read (I spent quite a long time not finding the frontend asset compilation docs), so I made some improvements:

  • Reorganize sections for better navigability
  • Add table of contents
  • Rework frontend assets section for clarity and DRY
  • Rework translating section for clarity, add "Add Translations" contribution type
  • Move release docs only useful for maintainers to RELEASING.md
  • Other miscellaneous improvements

alekstorm and others added 2 commits September 16, 2018 18:14
- Reorganize sections for better navigability
- Add table of contents
- Rework frontend assets section for clarity and DRY
- Rework translating section for clarity, add "Add Translations" contribution type
- Move release docs only useful for maintainers to RELEASING.md
- Other miscellaneous improvements
@mistercrunch
Copy link
Member

Thanks for doing this. That file has been evolving without keeping the big picture in mind for a while now!

I fixed a merged conflict and re-triggered the build which had a false-negative.

@codecov-io
Copy link

Codecov Report

Merging #5911 into master will increase coverage by 15.48%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #5911       +/-   ##
===========================================
+ Coverage   48.22%   63.71%   +15.48%     
===========================================
  Files         393      384        -9     
  Lines       23596    23545       -51     
  Branches     2630     2622        -8     
===========================================
+ Hits        11379    15001     +3622     
+ Misses      12217     8531     -3686     
- Partials        0       13       +13
Impacted Files Coverage Δ
superset/assets/src/chart/ChartBody.jsx 64% <0%> (-7.43%) ⬇️
superset/__init__.py 73.1% <0%> (-0.28%) ⬇️
...perset/assets/src/visualizations/MapBox/MapBox.jsx 0% <0%> (ø) ⬆️
superset/assets/src/explore/components/Control.jsx 38.09% <0%> (ø) ⬆️
...c/visualizations/MapBox/ScatterPlotGlowOverlay.jsx 0% <0%> (ø) ⬆️
...ts/src/explore/components/ExploreViewContainer.jsx 0% <0%> (ø) ⬆️
superset/assets/src/SqlLab/App.jsx 0% <0%> (ø) ⬆️
...ssets/src/visualizations/WorldMap/ReactWorldMap.js
superset/assets/src/visualizations/nvd3/NVD3Vis.js
superset/assets/src/utils/createAdaptor.jsx
... and 207 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8fff0d9...d40fdeb. Read the comment docs.

@mistercrunch mistercrunch merged commit 549328f into apache:master Sep 19, 2018
betodealmeida pushed a commit to lyft/incubator-superset that referenced this pull request Oct 12, 2018
- Reorganize sections for better navigability
- Add table of contents
- Rework frontend assets section for clarity and DRY
- Rework translating section for clarity, add "Add Translations" contribution type
- Move release docs only useful for maintainers to RELEASING.md
- Other miscellaneous improvements
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.28.0 labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.28.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants