Directions on how to contribute to this project (as a software developer)
32 views
Skip to first unread message
Felipe Vieira
Jan 18, 2025, 6:42:05 PMJan 18
to mnemosyne-proj-users
Hi, it's me again.
I like this software very much and I would like to contribute.
I'm a programmer with a few years of experience and given that I'm excited about this as a user, I could channel energy for the benefit of everyone (community and myself included). I've been writing a few modifications to mnemosyne for a while on a private repos.
My concern is about how to best channel this energy in a way that the current maintainers see value.
So from a very humble perspective, I would recommend running some basic CI/CD tooling on the codebase. One could argue that this is standard practice in the field. Are you ok with:
1. Running an automatic code formatter, e.g. [black](https://black.readthedocs.io/en/stable/index.html) with [pre-commit](https://pre-commit.com/).
2. Tests should be taken more seriously. Right now the tests hang here due to `tests/test_sync.py`. If I comment it out, `master` gives me:
```
============================================ 12 failed, 380 passed, 749 warnings in 8.02s =============================================
```
These failing tests should be commented out so that the entire test suite succeeds and only code that:
a. Adds new tests.
b. Passes all the tests.
should be merged.
Hopefully these recommendations sound like "everyday programming" in the large and not some arbitrary opinion from someone from the outside. I would also kindly put forth that this also encourages new contributions from the community as a whole.
I like this software very much and I would like to contribute.
I'm a programmer with a few years of experience and given that I'm excited about this as a user, I could channel energy for the benefit of everyone (community and myself included). I've been writing a few modifications to mnemosyne for a while on a private repos.
My concern is about how to best channel this energy in a way that the current maintainers see value.
So from a very humble perspective, I would recommend running some basic CI/CD tooling on the codebase. One could argue that this is standard practice in the field. Are you ok with:
1. Running an automatic code formatter, e.g. [black](https://black.readthedocs.io/en/stable/index.html) with [pre-commit](https://pre-commit.com/).
2. Tests should be taken more seriously. Right now the tests hang here due to `tests/test_sync.py`. If I comment it out, `master` gives me:
```
============================================ 12 failed, 380 passed, 749 warnings in 8.02s =============================================
```
These failing tests should be commented out so that the entire test suite succeeds and only code that:
a. Adds new tests.
b. Passes all the tests.
should be merged.
Hopefully these recommendations sound like "everyday programming" in the large and not some arbitrary opinion from someone from the outside. I would also kindly put forth that this also encourages new contributions from the community as a whole.
If you give me the green light I could add these in a PR pretty soon.
Looking forward to hearing back from you,
Peter Bienstman
Jan 19, 2025, 1:02:06 AMJan 19
to mnemosyne-proj-users
Sure, go ahead!
It might be a better idea to try and figure out why tests are failing rather then uncommenting them, though.
As I mentioned before, I'm not actively working on the codebase myself anymore, but happy to have others involved.
Cheers,
Peter
--
You received this message because you are subscribed to the Google Groups "mnemosyne-proj-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mnemosyne-proj-u...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/mnemosyne-proj-users/0edeae72-2a45-4d93-bc96-8af7fa0347a4n%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages