How to Contribute

[RalfBarkow]

[…] mark a recommended version for contributions (as you don’t have to suggest using 3.2.8. each time someone wants to contribute and as it can safe some time for people who do not contribute on a regular basis and will likely produce a pull request for the master main branch). This problem would, if I understand it correctly, be resolved if the Zettelkasten development changes to trunk based development, but it could still be useful in the meantime.

Also, speaking as a untalented autodidact I am, it would be great, if we could try to mark problems that are suitable for newcommers and people with limited skills like me. Of course I understand that there is a thin line here: I try to contribute with my limited skills but am aware that others are not responsible for helping me and that this should not end up being more work for them than doing things themselves. But the feenk example assumes a relatively fixed team of professionals and perhaps it could be good to create some inclusive opportunities beyond that in the Zettelkasten project?

So, I hope my story is somewhat convincing. ;)

Originally posted by @trutzig89182 in #375 (comment)

[RalfBarkow]

@trutzig89182 I would like to ask you to download the Glamorous Toolkit, see https://gtoolkit.com/download/ and then import our Zettelkasten project into it (Import Git > clone).

[RalfBarkow]

@trutzig89182
Then please use the open source Github repo for "Object-Oriented Reengineering Patterns" to download the book as a free PDF.

[RalfBarkow]

@trutzig89182 Pending Invite @ https://github.com/Zettelkasten-Team/Zettelkasten/invitations

[trutzig89182]

Thanks, @RalfBarkow. Downloaded the gttoolkit and the pdf, but run into an error importing the zettelkasten project. I will try to fix that and get a bit familiar with the toolkit this weekend.

[trutzig89182]

Ok, resolved the problem faster than expected and was able to import the project now. @RalfBarkow

[RalfBarkow]

[RalfBarkow]

[RalfBarkow]

Click on
to Register this Lepiter database:

[RalfBarkow]

In the Lepiter database, search for the Load the MSE file into a FAMIX model page and inspect the code snippet beginning with the comment "Load the Zettelkasten MSE file into a FAMIX model".

Note: You need to adjust the path to the Zettelkasten.msefile.

See also Parse Java code to export it to the MSE format #359

[RalfBarkow]

Select, e.g., All test methods and the BibTeXTest.testDocument():

[RalfBarkow]

[RalfBarkow]

Run the test, e.g., from within IntelliJ IDEA Community Edition.

[RalfBarkow]

Add a new test if you like.

[RalfBarkow]

Label issues and pull requests for new contributors

Now, GitHub will help potential first-time contributors discover issues labeled with good first issue

[trutzig89182]

I have done all the steps you suggested, @RalfBarkow.

[RalfBarkow]

I have done all the steps you suggested, @RalfBarkow.

Great, thanks @trutzig89182
Is there anything you would like to share?

By the way, the BibTeXTest.testDocument() test is created in the context of "The Test/Code Cycle in XP".

[trutzig89182]

Is there anything you would like to share?

To be honest, I will first need some days to understand better, what this is all about. I will hopefully have some time to delve deeper into this next weekend.

[RalfBarkow]

Thanks @trutzig89182 Take your time.

[mateusbraga]

Thanks @RalfBarkow for creating this How to Contribute. I found some problems as I was setting up my development setup, let me know if I should discuss these problems elsewhere.

• Glamorous Toolkit didn't run here. Maybe it doesn't work well on Windows. I am trying using Eclipse instead.
• Which branch should I develop new code on? I understood that it isn't main but didn't find what the right one should be.
• There is a .project in the main branch that seems broken. (At least Eclipse complained about it.) I deleted and it worked. Do you know why it is there for?
• In the main branch, I found 3 tests runnable with JUnit 5 and 5 tests runnable with JUnit 4. By looking at the test name, any idea why is that happening?
  
  

Thanks!

[RalfBarkow]

• There is a .project in the main branch that seems broken. (At least Eclipse complained about it.) I deleted and it worked. Do you know why it is there for?

@mateusbraga Yes, that .project file is related to Pharo Smalltalk/Glamorous Toolkit to load the Lepiter Database/Documentation.

[RalfBarkow]

• Glamorous Toolkit didn't run here. Maybe it doesn't work well on Windows.

@mateusbraga Download Glamorous Toolkit for Windows ⇒ https://dl.feenk.com/gt/GlamorousToolkitWin64-release.zip ⇒ in case of problems: Discord Chat: discord.gg/FTJr9gP

[RalfBarkow]

• Which branch should I develop new code on? I understood that it isn't main but didn't find what the right one should be.

@mateusbraga Yes, trunk based development on main branch.

[RalfBarkow]

• In the main branch, I found 3 tests runnable with JUnit 5 and 5 tests runnable with JUnit 4

@mateusbraga That would be exactly the area that I think we should improve.

[mateusbraga]

Thanks @RalfBarkow. I was able get Eclipse setup up and it seems to be working fine now. Quite interesting set of tools you mentioned, I haven't heard about them.

For future readers interested in using Eclipse, I remember doing two things that were not obvious to me at the time:

• Delete the existing .project. (Eclipse will create a new one after you set it as a Maven project with the existing pom.xml)
• To run the tests, as a confirmation that we can build Zettelkasten, I right clicked the project root folder, Run As -> Run Configuration..., add new project that runs all tests, run should work. If you manually break a test, it will start showing as broken.

(If they sound silly, for me it wasn't as it's been a while since I used Java.)

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[github-actions]

This issue is stale because it has been open for 30 days with no activity.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.