What's the process for getting a change reviewed and submitted?

Beman Website and Docs
1

Hi!

I ‘ve had a PR up for a few weeks but although there are 7 reviewers listed on it, there’s no review. Do I have to do something more than creating the PR?

Br,
Ted

2

Those reviewers come automatically from exemplar but most of us are too busy to review individual pull requests on Beman libraries-- usually people use the pull request mechanism to make sure the change passes CI but then just self-approve (which we have no rule/policy against doing).

Separately, though, if and when you think your library is at the point where it’s ready for us to give it “production ready” status, then it will go through a two-week evaluation by the community where we can go through it and provide feedback, as documented here:
https://github.com/bemanproject/beman/blob/main/docs/beman_library_maturity_model.md#review-process-for-transitioning-a-library-to-production-ready

3

Ok, but I just see “Merging is blocked Waiting on code owner review from …“ so I don’t think I can self-approve.

I do think the library is ready for review so I’ll read about the review process. Thanks!

4

Oh I’m sorry, I was confused because I didn’t follow your link-- I had thought you were talking about a pull request to bemanproject/timed_lock_alg, but this is a pull request for bemanproject/website.

I approved the pull request for the website.

1 Like
5

Thanks Ed!

I noticed that I need to provide more or less the same documentation as in the actual proposal(s), only in markdown, for it to be eligible for Production Ready status so I think I’m happy with “Under development and not yet ready for production use.” for now … unless there’s an easy way to transform a Word and html document (I used Word for P3832 and html for P3833) to markdown?

6

We’re still kind of figuring out how we want documentation for Beman libraries to work-- I think it might be better to leave it as “under development” for now until our expectations/process are more fleshed out. I’ll keep you updated.

1 Like
7

If the question is about putting the paper into the repo – I mean you’re going to need either html or pdf for ISO anyway. Easy enough with Word to export pdf. Another option might be to look at pandoc to get the source out of word and into markdown once and for all. Seems like most authors prefer Michael Park markdown How I format my C++ papers – Michael Park

It has some special features for dealing with c++.

@ednolan is correct though that we’re still working on the documentation story. But for now, user docs should be markdown in the repo with as many of the user examples as you can muster. Design decisions can refer to the paper.

1 Like
8

Thanks Jeff! I’ll see if I can get pandoc to make a markdown file of my P3832 Word proposal. For P3833 I actually started out with markdown and used pandoc + a little scripting to make it into html so that should be easier. Perhaps I could just include the markdown versions and the script in my beman repo instead of working on the proposals in a separate repo? That’d make it easier to co-operate on the actual proposals too, should anyone have suggestions for improvements to them.

9

This is what we encourage! The papers directory in examplar is there so that authors can have the proposal and code in the same place. It doesn’t work for libraries that are an independent implementation of something, but should be perfect for your effort.

1 Like
10

I see the same problems with my PR and Topics here.

I have time and be willing to help, but I am often waiting too long for any reaction?