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

Namespacing & function level separation? #6

Open
joshribakoff opened this issue Jul 3, 2013 · 3 comments
Open

Namespacing & function level separation? #6

joshribakoff opened this issue Jul 3, 2013 · 3 comments

Comments

@joshribakoff
Copy link
Contributor

I'd like to apply some namespacing (what is a good namespace to use?). I also feel like it could be a class with different functions. I'm afraid of causing a merge conflict if I do a PR for that though....

Also check this out.
https://github.com/blog/1547-release-your-software

No automatic changelog generation yet though.

@weierophinney
Copy link
Owner

RE: the github release support -- that was the impetus for releasing this project. I've been using some incarnation of it for some time now out of a working directory, for generating the changelogs for ZF2, which I also would paste into the individual tag annotations for that project. Now that these are displayed correctly by GitHub, several people were asking me how I did it -- and so I released the scripts.

@weierophinney
Copy link
Owner

I'd like to apply some namespacing (what is a good namespace to use?). I also feel like it could be a class with different functions.

To what end? To allow different output generation? or other reasons?

And don't worry about merge conflicts -- create a branch off of master, and keep it up-to-date by rebasing from the master branch of this repository. Once you're ready, create the PR.

@joshribakoff
Copy link
Contributor Author

Thanks for the background story on this project. The purpose of organizing the code would be to allow people to call it from a PHP script without having to make command line calls. People should be able to reuse some of the work you've done here. If I need to write a similar tool that needs to query the github API, there should be a class for that. Or if I want to modify your code to format the changelog text differently, or if I want to add a page to my website that displays the "planned" issues for the next milestone which updates in real time, maybe with Zend\Cache wrapped around it. Don't know if that makes sense.

At the very least, as we add new features to your component it should be organized into functions. Better yet a class, so people could extend the class and override, for example, the method that formats the issues in the changelog.

However if we to do that it also opens up a can of worms with distribution. Do we cram all these classes into one big .php file? Do we separate them to 1 class per file? Do we distribute a .phar when we do a release? I don't want to over complicate things here, but at the same time the tool currently lacks extensibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants