How and why to make your project known.

1. Publishing
Libraries & Frameworks
Sven Van Caekenberghe

2. Pharo is a platform

3. Enables you to write
real world applications

4. Pharo is open source,
has an eco system
& active community

5. Pharo needs 3rd party
libraries & frameworks

6. Solve specific
enterprise & application needs

7. Connect & interface
to the outside world

8. You wrote something that
might be useful to others

9. Consider giving back
to the community

10. Publish your library or
framework as open source

11. Pro’s
more users, more testers, more feedback
feature requests, feature additions
higher quality, better maintenance

12. Con’s
more work, more responsibility
a commitment for the future
need for support, need for marketing

13. Pharo eco system
offers various free tools

14. Write, publish & maintain
high quality code

15. Let’s get started

16. Define your
component,
library,
framework

17. Boundaries
Dependencies

18. Source Code

19. Source code
package definition
> Monticello, RPackage

20. Package names
Name space prefix
Extensions

23. Source code management
> Monticello

25. Repository
> SmalltalkHub, github, …

28. Source code management
> Metacello

29. One-click loading
One-expression loading
One-command loading

33. Dependency management
Version management
Platform management

34. baseline1: spec
<version: '1-baseline'>
spec for: #common do: [
spec
blessing: #baseline;
author: 'Sven Van Caekenberghe';
repository: 'http://smalltalkhub.com/mc/SvenVanCaekenberghe/Reddit/main/'.
spec project: 'Seaside3' with: [
spec
className: 'ConfigurationOfSeaside3';
versionString: #stable;
repository: 'http://www.smalltalkhub.com/mc/Seaside/MetacelloConfigurations/main' ].
spec project: 'Glorp' with: [
spec
className: 'ConfigurationOfGlorp';
versionString: #stable;
repository: 'http://www.smalltalkhub.com/mc/DBXTalk/Configurations/main' ].
spec project: 'PostgresV2' with: [
spec
className: 'ConfigurationOfPostgresV2';
versionString: #stable;
repository: 'http://www.smalltalkhub.com/mc/PharoExtras/PostgresV2/main' ].

35. baseline1: spec (cont’d)
spec
package: 'GlorpDriverPostgreSQL'
with: [
spec
repository: 'http://www.smalltalkhub.com/mc/PharoExtras/PostgresV2/main';
postLoadDoIt: #postLoadGlorpPostgresNativeDriverDBXTalkPharo;
requires: #( 'Glorp' 'PostgresV2' ) ].
spec
package: 'Reddit'
with: [ spec requires: #( 'Seaside3' 'GlorpDriverPostgreSQL') ].
spec group: 'Core' with: #( 'Reddit' ).
spec group: 'default' with: #( 'Reddit' ) ]

36. Configuration browser
One-click install
Blessed repo for configurations

37. Tests

38. Unit Tests
Functional Tests
Regression Tests

39. Validate & Protect
your code base

40. Facilitate
> refactoring
> porting
> contributions

41. “Something not tested
does not exist”

42. “How To” Unit Tests
Live, validated examples

43. Tools

44. Code critics
Lint rules

46. Time/space profilers
Coverage tools

47. CI

48. Continuous Integration

51. Independent,
controlled build

52. For each change in source,
dependencies or platform

53. Based on Configuration target
Based on Source code repo

54. Build Matrix
Versions, Platforms, VMs

55. Run all tests
Notify on failure
Build artefacts

60. Docs

61. Documentation,
documentation,
documentation

62. Even well written code
needs documentation

63. Class names
Methods names
Style & Design

64. Class comments
Method comments
Implementation comments

65. Not the obvious things
Rephrase, externalise
Guide new users

66. Help System
In Image
Interactive Tutorial

67. Real, separate
documentation

68. Papers, tutorials,
articles, presentations

69. Pillar Markup
Pillar Tool - PillarHub
HTML, PDF, Markdown

70. Markdown
Github, SmalltalkHub

71. Catalog Info on Configurations
Project Poster

72. Use mailing lists
Use MC package for contributions
Use github issue system - PR

73. Debugging in the field
> PharoDebug.log
> Fuel out stack

74. Support your software
Engage your users

75. Publishing
Libraries & Frameworks
Thank you for your attention

76. Q & A