jhipster / jhipster-core

JHipster Domain Language, used by JHipster UML and JDL-Studio to generate entities
Apache License 2.0
346 stars 116 forks source link

Add doc about how to contribute #393

Closed MathieuAA closed 4 years ago

MathieuAA commented 4 years ago

For instance:

SudharakaP commented 4 years ago

@MathieuAA : This I think would be helpful. I can help write it down in the README and/or in our website if you could let me know some details of the project structure. 😄

MathieuAA commented 4 years ago

Hi @SudharakaP! It's done already :) or at least the significant part of it. My intent here was to close this one, create a GH project and fill it with cards that'd be converted into relevant issues. If you wanna contribute, I'd be interested in someone helping me on this stuff! An other viewpoint is more than welcome!

SudharakaP commented 4 years ago

Willing to help you out for sure. So you mean https://github.com/jhipster/jhipster-core/projects/9 is the new project for these documentation tracking? 😄

MathieuAA commented 4 years ago

Yes. As soon as I finish fixing #404 & #432, I'll create cards... You can create cards too by the way! That way, I'll know what's lacking more easily

SudharakaP commented 4 years ago

@MathieuAA : Wonderful. I'll add some if and when I think of some ideas. But I was thinking, what might be really useful to start with is a method to test the JCore without creating new releases. This would enable people like me to do a change and test it out easily. Let me think of a method.... 🤔

MathieuAA commented 4 years ago

The "npm link" thing works quite well when one wants to check the integration between the generator and JCore. If you're thinking about "how can I test something in particular in JCore", then a test always does the trick for me. Documenting it would be a good idea.

SudharakaP commented 4 years ago

Ah, totally forgot npm link. Exactly what I was looking for. Definitely should include in the docs. I've added a card as well. 😄

MathieuAA commented 4 years ago

Great!