back to Developing for Flow Wiki
When you provide a pull request that enhances an existing extension, here’s the best practice for reporting it to the community:
First, determine whether the change is big enough to deserve a post. The general rule of thumb is that bug fixes aren’t worth getting their own post, but new functionality is unless it’s really minor. When in doubt, report on it!
Second, write up the functionality for an Announcement Post. Provide images and if possible) animated gifs or video to show your functionality in action. Unless the configuration is really easy, make sure you provide screen shots showing examples of configuration. If you’ve been given Author credentials on UnofficialSF, create a Post there and save it in draft format with your content. Otherwise, create a Google Doc. (Don’t use Word or Quip because they don’t convert cleanly to the WordPress system that UnofficialSF runs on).
If you’re not confident in your English skills, don’t worry. We can edit your text before publishing.
Third, edit the Main Documentation Post for the extension to incorporate your new documentation. This is generally the post that originally announced the extension. These posts serve as the sole source of truth for documentation about the extension. Because we don’t want users to have to go to multiple places in the future, it’s important that your documentation be integrated into the extension’s main Post, even if that duplicates the Announcement Post. Generally, when editing an existing post, it’s best to copy it from UnofficialSF to a new Google Doc and let a site administrator merge the changes. Make sure to unify things like tables of input parameters (i.e. all the inputs including your new inputs should be in a single table in the main documentation post. It can be a good idea to mark any new inputs or outputs you’ve added with a NEW! prefix.
When you’re done writing up your enhancements, leave a comment in the github PR and we’ll review and publish.