Road map for V2.0 🗺️ #85
Replies: 10 comments 13 replies
-
|
@connorferster in terms of working through the remaining tasks; are you hoping we'd work off your fork, or shall you commit this PR into a new v2 branch of this repo that we could work off? And to avoid overlapping tasks, we could either (a) have a to-do check list in this discussion people can claim items to work on, or (b) create an issue for each to-do, that people can claim (along with tags)? You can add modularizing the library of built-in sections and I'll take that on with some design input from everyone! |
Beta Was this translation helpful? Give feedback.
-
|
Committing this PR onto a new v2 branch would be a good call. I also like (b) for tasks. Will also add the "section library" to the list. |
Beta Was this translation helpful? Give feedback.
-
|
Great work @connorferster and all that have been involved in this project! I am currently reviewing the new code and writing up the theory docs. Bit sad to see the rainbow colours go on the plots, but agree the new scheme is more professional and useful 😢 |
Beta Was this translation helpful? Give feedback.
-
|
@robbievanleeuwen, further to @ccaprani above, are you able to create a new |
Beta Was this translation helpful? Give feedback.
-
|
Wait, why does it now say "Author" beside my name!?!? YIKES!!! Robbie, I think you should retain the "Author" mantle and maybe just make me a Maintainer? |
Beta Was this translation helpful? Give feedback.
-
|
@connorferster just created the v2 branch, feel free to merge your shapely branch. I think you're author because you started this discussion thread ;) |
Beta Was this translation helpful? Give feedback.
-
|
Lol, ok good :) |
Beta Was this translation helpful? Give feedback.
-
|
The |
Beta Was this translation helpful? Give feedback.
-
|
Hi Connor, Now that we don't have a pull request, what do you think would be the best way to incorporate code review comments through github? Do you think creating issues is the best platform for this? Robbie |
Beta Was this translation helpful? Give feedback.
-
|
With reference to the above, was just getting the setup.py updated in v2 and noticed a stale(?) reference to IPython in sections.py, I commented out this line because I wasn't entirely sure it should be removed but this doesn't feel like the best workflow as it's probably best to get you review the changes before committing to the v2 branch. Do you think it's best to pull request any changes to the v2 branch? Keen to hear your thoughts on the best workflow here. |
Beta Was this translation helpful? Give feedback.
-
|
Hi @robbievanleeuwen, I think submitting pull requests to the v2 branch will allow us to do efficient reviews. I think it will look like this:
I think a good idea is for each pull request to focus on just one thing, e.g. if the idea is to edit one page of the docs, then create a branch and pull request for just that scope. This way it will be easier to prevent merge conflicts or fix them when they do come up. Thanks for catching that fix: I have a terrible habit of leaving instrumentation in my code (I am sure there is a tools for that somewhere...) We can post an issue if someone does not have the comfort level to fix a particular thing but I think that, generally speaking, it would be more efficient to just do the fix (again, keeping the scope small) and submit a pull request. Let me know your thoughts on this. |
Beta Was this translation helpful? Give feedback.
-
|
Ok great, this sounds like a good plan! You can see that I'm only used to working with myself 😅 ... |
Beta Was this translation helpful? Give feedback.
-
|
flake8 and pylint would catch it :) I agree that a PR to v2 branch makes the most sense |
Beta Was this translation helpful? Give feedback.
-
|
Hi all, I have enabled building v2 in the readthedocs, so if anyone wants to look at the current state of the docs for the v2 branch without building it locally you can find it here: |
Beta Was this translation helpful? Give feedback.
-
|
That's so cool. Did not know one could do that! |
Beta Was this translation helpful? Give feedback.
-
|
@robbievanleeuwen @connorferster Did you guys decide on a formatting scheme yet? Are we to just do flake8 checks, or can we be more opinionated by using black formatting. This could even just be added to the CI. |
Beta Was this translation helpful? Give feedback.
-
|
I am a fan of black, myself. Any objections?
…Sent from my iPhone
On Oct 12, 2021, at 19:39, Colin Caprani ***@***.***> wrote:
@robbievanleeuwen @connorferster Did you guys decide on a formatting scheme yet? Are we to just do flake8 checks, or can we be more opinionated by using black formatting. This could even just be added to the CI.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
Beta Was this translation helpful? Give feedback.
-
|
I'm a fan of black, although I don't have time right now to put any effort
towards v2... Having it built into CI sounds good.
On Wed, Oct 13, 2021 at 12:08 AM Connor Ferster ***@***.***>
wrote:
… I am a fan of black, myself. Any objections?
Sent from my iPhone
> On Oct 12, 2021, at 19:39, Colin Caprani ***@***.***> wrote:
>
>
> @robbievanleeuwen @connorferster Did you guys decide on a formatting
scheme yet? Are we to just do flake8 checks, or can we be more opinionated
by using black formatting. This could even just be added to the CI.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub, or unsubscribe.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#85 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABVBQOVYQCCTGG35B2RKKDDUGUH3FANCNFSM5EKZZA6Q>
.
Triage notifications on the go with GitHub Mobile for iOS
<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675>
or Android
<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
--
-Ben
|
Beta Was this translation helpful? Give feedback.
-
|
Just noting this Github Action recipe for later: https://github.com/rickstaa/action-black |
Beta Was this translation helpful? Give feedback.
-
|
I have two weeks off of work coming up next week. Will be jumping back on sectionproperties next week! |
Beta Was this translation helpful? Give feedback.
-
|
I've got time over the next few weeks as well! I reckon we can v2 before 2022! |
Beta Was this translation helpful? Give feedback.
-
|
I have been thinking about After replacing all of the |
Beta Was this translation helpful? Give feedback.
-
|
Yes sounds good, and I think with #132, we should rename |
Beta Was this translation helpful? Give feedback.
-
Hi @ccaprani , @Czarified, @Spectre5, @Agent6-6-6, @robbievanleeuwen;
We are really quite close to being able to release v2.0. I want to thank everyone for the assistance/input/feedback to date. It has been really valuable.
I wanted to share with you all what I see as the v2.0 road map so we can hopefully get this done in the next five weeks (see note at end).
Road map as follows:
👨💻 Shapely pre-processor code
Shapely pre-processor code ✔️ : I view this as being complete. There may be some small additional bugs yet to be discovered but I am confident, from @Agent6-6-6's review, that it's generally working smoothly.
.plot_geometry()method that adds some features similar to @Spectre5's PR but not all of them. I am going to review the changes from @Spectre5 and try and bring them in.📝 Documentation (currently in progress):
Additional items:
🧰 Build tools
@Spectre5's PR contains some excellent updates to the package. The goal is to incorporate as many of them as possible into the v2.0 release, specifically:
At minimum, the documentation needs to be completed prior to v2.0 release. I would also like to include the items from "Build tools". From there, I think we are good to release and then start making further decisions.
Thoughts?
Beta Was this translation helpful? Give feedback.
All reactions