LatticeQCD
Move pull request guidelines to SIMULATeQCD/community
We have the "How to do pull requests" documentation; I think it makes sense to include our guidelines there. I have already included some steps to take when merging a feature into the main branch. I think we should also include some extra guidelines for a pull request, to help us check that the merger did everything correctly. For example:
- I noticed that people are again writing tests are not really tests; i.e. they don't have a clear pass/fail condition. I am trying to include all the tests in
scripts/TEST_run.bash, and without it returning some kind of error, the script just assumes it passed. This leads to some "tests" that are never really being checked. We should not allow someone to merge until they've implemented this. - Along these lines, I am seeing people put executables in the wrong place, like profilers in the
testingfolder. We can probably think of more stuff. Maybe we can make the guideline that when someone submits a pull request, they have to explicitly tell us a few things, like - I confirm that I did
make -j everythingand it all compiles. - I confirm that I ran
TEST_run.bashand everything passed. - Here are the new tests I wrote, please look at them Anything you guys would like to add?
People mainly run tests when they have changed the code (added features, etc.). Especially for new users, it would be nice to have everything you need to know about "Contributing to the code", including everything about the test suite, in one place, and not scattered across multiple pages in the documentation. It should be as easy as possible for new users to add code. Maybe we should put a section about this into the readme?
I agree with this. I tend to agree that our documentation is split up a little bit too much.
I also really like what you did with these TL;DR admonitions. Can you set up something like that for contributing to the code? I personally find it really helpful to have a quick overview of what I need to do, and then I can look into each step in detail when I need to.
Maybe there is an even better place for this, which you can find here: https://github.com/LatticeQCD/SIMULATeQCD/community There are multiple things that are still missing there, which we should add.