Contributing code

[JeroenvdV]

Hi,

I'm curious about the process for potentially contributing code to this project. I don't believe there are any guiding notes for how you would like changes to be delivered, if at all.

• Are the latest changes such as https://sankeymatic.com/build-next/ available in this repository to branch from?
• Is the code in this repository the actual source, or are (parts of it) generated by a build script that operates on a different source code that isn't available?

[nowthis]

Hello @JeroenvdV. Thanks for the questions & the PRs.

Re: the features at /build-next/ -

• That code is not currently in any repository; it's been in flux as I try to refine it into an acceptable UI and less clumsy code. I believe it's just about ready; I plan to get nearly all of those changes incorporated into the main site over this holiday season once I can organize them into a sensible set of commits.

Re: contributing:

• It's true that I haven't thought to set up a CONTRIBUTING file yet. I've been thinking of SankeyMATIC more as a personal project that people can fork for their own purposes, not as a community effort. I should work out what contribution guidelines I want to post. That said, I have incorporated some pull requests from time to time.
• I will incorporate the debounce PR soon, for sure.
• I'm not sure about the file-linking one; I'm trying to stick to features well-supported across all the browsers, plus I'm not sure how much interest there is in tying diagrams to local files. (I can see some utility though, and will try it out for myself at some point.)

Re: a build script:

• I don't currently use any, it's all manually managed.
• These are the files that I directly edit, they are not generated from something else. Why do you ask?

[JeroenvdV]

Thanks for your response!

Re: the features at /build-next/ -

* That code is not currently in any repository; it's been in flux as I try to refine it into an acceptable UI and less clumsy code. I believe it's just about ready; I plan to get nearly all of those changes incorporated into the main site over this holiday season once I can organize them into a sensible set of commits.

W.r.t. contributing, although I understand it was never your intention, having that revision in a branch would allow me to integrate any changes properly with the latest (albeit WIP) version of the code so that you as owner and maintainer wouldn't have to do unnecessary steps.

* I'm not sure about the file-linking one; I'm trying to stick to features well-supported across all the browsers, plus I'm not sure how much interest there is in tying diagrams to local files. (I can see some utility though, and will try it out for myself at some point.)

I understand the considerations. I found myself tweaking the input in my favorite text editor rather than the browser, and then having to reload it repeatedly so I automated that for my own benefit. I could even imagine the input being generated from another source.

Re: a build script:

* These are the files that I directly edit, they are not generated from something else. Why do you ask?

I ask just to make sure that I'm not editing code in the wrong place, that would be overwritten by a build. I noticed that the single file is quite large and I usually work in projects with parts separated into many files, and it could have been put together from such a structure. I do like the structure of the code though.