davidderaedt / annotate-extension

Brackets extension to generate JSDoc annotations
MIT License
18 stars 13 forks source link

Design of project #27

Open ajorquera opened 10 years ago

ajorquera commented 10 years ago

Hello my name is Andrew and I have a few ideas I will like to discuss. This the first project I have contributed, so maybe I'm wrong in a lot of things.

*Design pattern: I have checked the code and I don't see a clear pattern of design. So, maybe we can discuss about the design.

*Discussion over each pull: maybe before the owner of the project makes a merge, he can give at least a few days to discuss about the code. This way, contributors can give their opinions about it.

*Create a branch for development: maybe the owner can make a develop branch. This way we can test that nothing breaks before releasing the new version.

*Unnecessary pull request: I have seen sometimes that people will make pull requests just for minor changes that doesn't really make a difference.

I think we can work better and more efficient if we all put our heads together than just working by ourselves. If anyone has other ideas or think I'm wrong, please feel free to post.

davidderaedt commented 10 years ago

Hi Andrew,

Thanks for your message. I agree with a lot of things you said. I admit I was too quick to merge lately, there was a lot of activities around some of my projects. I guess I've just been lazy.

1/design patterns: agreed, but let's take problems,one by one and open specific issues for each specific design problem identified.

2/completely agree, unless it is trivial, I'll now wait a few days before merging.

3/dev branch. I'm not sure about this one. The production build is supposed to go the brackets ext rep, so there already is a separation. What do you think?

ajorquera commented 10 years ago

Hi David,

It's cool to be part of a project that I can be involve and help. I'm very grateful for it.

  1. For the design we need to think about it. When we come with a proposal we can just open an issue and talk about it as you said. But, I think we should focus object oriented programming instead of procedural.
  2. You are right with the branch, there is already a separation. But, with a new branch people can clearly see the difference between the current version and the new one. Each commit to the master branch should be a new version of the extension and not just a simple modification (unless is urgent). Every version should be one that adds new features and resolves all the issues of the current one. If you give a few days for each pull request you should give more time for updating the extension.

I'm not sure if that's the right way to go. I don't have a lot of experience in this. Maybe I'm adding to much complexity to a small project.