Contribution guide

[mishc9]

Hi @alegonz!

Our team implemented several features for baikal during in-house project. Now we'll plan to contribute back, but the changes are significant, and we have some questions.

• Do you prefer any conribution guide or specific workflow for PRs?
• Do you have some to-do list? There was one in previous version, but may be it's no loneger relevant.
• Should we create an issue for each proposed feature or so? (i.e early stopping, cache etc.)
• We made some changes in core and also change default behaviour of graph. Is it allowed? Can we discuss these changes?

[alegonz]

Hello @mishc9 !

Thank you for your interest in the project!

Do you prefer any conribution guide or specific workflow for PRs?

I haven't got into that yet. I've been preparing the 0.3.0 with better documentation and a contribution guide/PR workflow is among my TODO. For the moment, while I come up with those docs, I think we can start discussing the topics on issues.

Do you have some to-do list? There was one in previous version, but may be it's no loneger relevant.

I used to have a TODO in the README, but recently I moved it to Issue #16. Future work is roughly listed up in the "New features and changes planned for 0.4.0 and later" section of this comment, but that is flexible.

Should we create an issue for each proposed feature or so? (i.e early stopping, cache etc.)

Yes, ideally I'd like to decouple each topic and proposed change as much as possible. That way it is easier to avoid confusion and have more manageable PR granularity.

We made some changes in core and also change default behaviour of graph. Is it allowed? Can we discuss these changes?

In principle, I don't oppose changes to the _core module and it is open to discussion. The important thing is that I'd like to base our discussions on the latest master, which is the implementation of the 0.3.0 version and has several important API changes that I'll release soon.

---

Please bear in mind that I can't promise you upfront that I'll accept any new feature/API change. I will determine that from the results of each discussion. Of course, I look forward to what you and your team came up with :)

The upcoming days I'll have my hands full with life AFK, so please allow me some time to get back to you in detail, but feel free to open new issues for each topic in the meanwhile :)

[mishc9]

Yes, ideally I'd like to decouple each topic and proposed change as much as possible. That way it is easier to avoid confusion and have more manageable PR granularity.

OK, I'll start to build neat PR's from our local changes. I wil note if they include _core changes.

The upcoming days I'll have my hands full with life AFK, so please allow me some time to get back to you in detail, but feel free to open new issues for each topic in the meanwhile :)

Thank you! Probably I'll start with caching because it's hardest feature to maintain while it evolves separately from main library. But I'm not sure if I'll open an issue during holidays.

Some changes we did are required just for our needs. So, it'll be fine if you don't accept them, we'll keep them in fork.

Thank you for the contribution instructions :)

[alegonz]

Hi there, @mishc9 .

Sorry for the delay.

I added a document with the contribution guidelines. I hope that document helps you. If you have any other question or doubt, please let me know.

[alegonz]

Closing due to inactivity. Feel free to reopen if you need further help.