+1 to putting a link in README.md to more detailed building instructions. There already is a "Building & testing" section in "Beam Contribution Guide"[1]. Maybe it's a good idea to just extend it with the contents from the above-mentioned documents?
[1] https://beam.apache.org/contribute/#building--testing pt., 20 lip 2018 o 18:15 Thomas Weise <[email protected]> napisał(a): > Yep, at least a link should be in README.md. Whether all details should be > captured there may be another matter, I thought of wiki/Confluence because > it is easier to edit. > > Thomas > > On Fri, Jul 20, 2018 at 8:59 AM Jean-Baptiste Onofré <[email protected]> > wrote: > >> Hi, >> >> as discussed together yesterday, it's a good idea. >> >> IMHO, it should be directly in README.md. Let me explain, you are a >> contributor, you cloned the repository locally and you want to build. >> >> So, you will probably start with ./gradlew projects and ./gradlew tasks. >> >> However, pretty soon, you will look for some "basic" tricks: executing a >> test, publishing SNAPSHOT in local repository, ... >> And you are offline (coding during a flight, ...). >> >> That's why I think README.md or BUILDING.md is a great location because >> it comes with the sources you want to build. >> >> Regards >> JB >> >> On 20/07/2018 16:41, Alexey Romanenko wrote: >> > Hi all, >> > >> > Since we totally have moved to Gradle as Beam build system (after final >> > removing all maven poms recently), don’t you think that we need to add a >> > dedicated page or, at least, a paragraph, into Contribution Guide where >> > to add more examples of some tips&tricks while using Gradle? >> > >> > Comparing to Maven, I can guess that not so many people are so well >> > aware about how to use Gradle (me is a good example for that =)). For >> > instance, it can be quite useful to add some information, like, how to >> > build and publish maven artefacts locally (that can be used for testing >> > when you wish to build and run pipeline with custom jars), running >> > integration tests, remote debugging and etc. >> > >> > Ismaël Mejía and Luke Ćwik already started to write up such things in >> > these docs: >> > >> https://docs.google.com/document/d/1wR56Jef3XIPwj4DFzQKznuGPM3JDfRDVkxzeDlbdVSQ/ >> > >> https://docs.google.com/document/d/1EiTwEMD8FNhU4Ok6jthASpmK3-1hiAYzVTrdl8qBLrs >> > >> > So, based on these docs, check that they are up-to-date with last >> > changes and create such new page on website which should help >> contributors. >> > >> > What do you think? >> > >> > Alexey >> >
