Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 1.9 KB

Contributing to ShapeCrawler

A big welcome and thank you for considering contributing to ShapeCrawler's open source project!

Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issues, assessing changes, and helping you finalize your pull requests.

Development Flow

  1. Fork the repository
  2. Clone the forked repository
  3. Make a feature or fix bug
  4. Build the Release configuration of the solution to ensure that all code style checkers pass
  5. Create a Pull Request

Recomended tools

The internal structure of PowerPoint presentation is one the most difficult among other documents from the Microsoft Office suite. For example, the slide presented for a user is not a single document but only top on Slide Layout and Slide Master slides. Even just that levels frequently lead to confusion. The following is a list of tools and notes that should simplify your development while working on ShapeCrawler's issue.

  • OOXML Viewer — extension for Visual Studio Code allowing to view Open XML package. One of the good features of this extension is track changes of modified presentation.
  • Open XML SDK 2.5 Productivity Tool — application for generating C#-code from Open XML document. It can be useful, for example, when you wanna know what C#-code is needed to add a new shape or slide.
  • .pptx is ZIP — do not forget that .pptx-file is a zip file as well as other Open XML documents. Thus you can rename the extension of the presentation file on .zip and watch his internals:

.pptx is zip