[libvirt PATCH 0/2] Improve entry point for new contributors
Use the path most people will look for, reduce building instructions to the bare minimum necessary to locally bootstrap the learning process, and ensure duplication doesn't creep in over time by pointing to the full documentation. Andrea Bolognani (2): CONTRIBUTING: Add entry point for new contributors README-hacking: Drop from the git repository CONTRIBUTING.md | 18 ++++++++++++++++ README-hacking | 56 ------------------------------------------------- 2 files changed, 18 insertions(+), 56 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 README-hacking -- 2.25.1
It's generally expected that a git repository will contain this file, which serves as an entry point for people interested in contributing to the project. In our case, we have extensive documentation available on the website which we don't want to duplicate, so let's just point people there. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..a8551965bd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +Contributing to libvirt +======================= + +Full, up to date information on how to contribute to libvirt can be +found on the libvirt website: + +[https://libvirt.org/hacking.html](https://libvirt.org/hacking.html) + +To build the same document locally, from the top level directory of +your git clone run: + +``` +$ mkdir build && cd build +$ ../autogen.sh +$ make +``` + +You'll find the freshly-built document in `docs/hacking.html`. -- 2.25.1
On a Monday in 2020, Andrea Bolognani wrote:
It's generally expected that a git repository will contain this file, which serves as an entry point for people interested in contributing to the project.
In our case, we have extensive documentation available on the website which we don't want to duplicate, so let's just point people there.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..a8551965bd --- /dev/null +++ b/CONTRIBUTING.md
s/md/rst/
@@ -0,0 +1,18 @@ +Contributing to libvirt +======================= + +Full, up to date information on how to contribute to libvirt can be +found on the libvirt website: + +[https://libvirt.org/hacking.html](https://libvirt.org/hacking.html)
https://libvirt.org/contribute.html
+ +To build the same document locally, from the top level directory of +your git clone run: + +``` +$ mkdir build && cd build +$ ../autogen.sh +$ make +``` + +You'll find the freshly-built document in `docs/hacking.html`.
s/hacking/contribute/
--
Reviewed-by: Ján Tomko <jtomko@redhat.com> Jano
On Tue, 2020-04-14 at 10:14 +0200, Ján Tomko wrote:
On a Monday in 2020, Andrea Bolognani wrote:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..a8551965bd --- /dev/null +++ b/CONTRIBUTING.md
s/md/rst/
Good point. I've verified that both GitLab and GitHub can render reStructuredText correctly; I'll look into converting the few remaining Markdown files in the repository to reStructuredText as well. -- Andrea Bolognani / Red Hat / Virtualization
The newly-introduced CONTRIBUTING.md serves the same purposes and lives in the path where most people would look for it. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- README-hacking | 56 -------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 README-hacking diff --git a/README-hacking b/README-hacking deleted file mode 100644 index 89fa86be30..0000000000 --- a/README-hacking +++ /dev/null @@ -1,56 +0,0 @@ --*- outline -*- - -These notes intend to help people working on the checked-out sources. -These requirements do not apply when building from a distribution tarball. -See also docs/hacking.html (after building libvirt using the information -included in this file) for more detailed contribution guidelines. - -* Requirements - -We've opted to keep only the highest-level sources in the GIT repository. -This eases our maintenance burden, (fewer merges etc.), but imposes more -requirements on anyone wishing to build from the just-checked-out sources. -Note the requirements to build the released archive are much less and -are just the requirements of the standard configure && make procedure. -Specific development tools and versions will be checked for and listed by -the bootstrap script. - -Valgrind <http://valgrind.org/> is also highly recommended, if -Valgrind supports your architecture. - -While building from a just-cloned source tree may require installing a -few prerequisites, later, a plain `git pull && make' should be sufficient. - -* First GIT checkout - -You can get a copy of the source repository like this: - - $ git clone https://libvirt.org/git/libvirt.git - $ cd libvirt - -We require to have the build directory different than the source directory: - - $ mkdir build && cd build - -The next step is to invoke ../autogen.sh: - - $ ../autogen.sh - -And there you are! Just - - $ make - $ make check - -At this point, there should be no difference between your local copy, -and the GIT master copy: - - $ cd .. - $ git diff - -should output no difference. - -Enjoy! - -Local Variables: -indent-tabs-mode: nil -End: -- 2.25.1
On a Monday in 2020, Andrea Bolognani wrote:
The newly-introduced CONTRIBUTING.md serves the same purposes and lives in the path where most people would look for it.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- README-hacking | 56 -------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 README-hacking
Reviewed-by: Ján Tomko <jtomko@redhat.com> Jano
On Mon, 2020-04-06 at 12:07 +0200, Andrea Bolognani wrote:
Use the path most people will look for, reduce building instructions to the bare minimum necessary to locally bootstrap the learning process, and ensure duplication doesn't creep in over time by pointing to the full documentation.
Andrea Bolognani (2): CONTRIBUTING: Add entry point for new contributors README-hacking: Drop from the git repository
CONTRIBUTING.md | 18 ++++++++++++++++ README-hacking | 56 ------------------------------------------------- 2 files changed, 18 insertions(+), 56 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 README-hacking
ping -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani -
Ján Tomko