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.

Sign up for GitHub

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

Jump to bottom

Improve documentation how to write addins #1049

Open
1 of 3 tasks
pascalberger opened this issue Oct 3, 2020 · 2 comments
Open
1 of 3 tasks

Improve documentation how to write addins #1049

pascalberger opened this issue Oct 3, 2020 · 2 comments
Labels
documentation help wanted up-for-grabs

Comments

@pascalberger
Copy link
Member

pascalberger commented Oct 3, 2020 •
edited
Loading

We should improve documentation how to create new addins for Cake. Currently we have some documentation here: https://cakebuild.net/docs/extending/addins/. We should add more detailed documentation how to write addins.

This includes mentioning of https://github.com/WormieCorp/generator-cake-addin and https://github.com/WormieCorp/Cake.Addin.Analyzer.

Also should mention Cake Contrib and guidelines etablished there: https://github.com/cake-contrib/Home/blob/master/Guidelines.md, https://github.com/cake-contrib/CakeContrib.Guidelines

TODO:

  • Add best practices
  • Add instructions how to create addin from scratch, including generator options
  • Add documentation about available analyzers
@pascalberger
Copy link
Member Author

See also #368

@pascalberger pascalberger changed the title Add documentation how to write addins Improve documentation how to write addins Oct 3, 2020
@pascalberger
Copy link
Member Author

See also #151

This was referenced Oct 4, 2020
Open
Merged
@pascalberger pascalberger mentioned this issue Dec 2, 2020
Open
pascalberger added a commit to pascalberger/website that referenced this issue Dec 12, 2020
@pascalberger
(cake-buildGH-1049) Add best practices for writing addins
267e010
@pascalberger pascalberger mentioned this issue Dec 12, 2020
Merged
pascalberger added a commit to pascalberger/website that referenced this issue Dec 12, 2020
@pascalberger
(cake-buildGH-1049) Add best practices for writing addins
d783c98
pascalberger added a commit to pascalberger/website that referenced this issue Dec 13, 2020
@pascalberger
(cake-buildGH-1049) Add best practices for writing addins
77912bf
pascalberger added a commit that referenced this issue Dec 13, 2020
@pascalberger
Merge pull request #1352 from pascalberger/feature/addin-best-practices
f4cd4d3 
(GH-1049) Add best practices for writing addins
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted up-for-grabs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@augustoproiete @pascalberger