From f0018dabe36d841c64efb9bdf79ce72ec6977350 Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Thu, 13 Feb 2020 17:32:04 -0500 Subject: [PATCH] 16080: More tweaks on CONTRIBUTING and README Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- CONTRIBUTING.md | 25 +++++++++++++++---------- README.md | 27 ++++++++++++++------------- 2 files changed, 29 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28ba118eb7..459d7277a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,15 +11,16 @@ reports, bug fixes, new features, and scripts or documentation that help with using, administering, or installing Arvados. We also love to hear about Arvados success stories. -Interested contributers should begin by joining the [Arvados community -channel](https://gitter.im/arvados/community) and tell us what you -have found or how you would like to contribute. +Those interested in contributing should begin by joining the [Arvados community +channel](https://gitter.im/arvados/community) and telling us about your interest. Contributers should also create an account at https://dev.arvados.org to be able to create and comment on bug tracker issues. The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues . +Contributers may also be interested in the [development road map](https://dev.arvados.org/issues/gantt?utf8=%E2%9C%93&set_filter=1&gantt=1&f%5B%5D=project_id&op%5Bproject_id%5D=%3D&v%5Bproject_id%5D%5B%5D=49&f%5B%5D=&zoom=1). + # Development Git repositories for primary development are located at @@ -32,6 +33,9 @@ Visit [Hacking Arvados](https://dev.arvados.org/projects/arvados/wiki/Hacking) f detailed information about setting up an Arvados development environment, development process, coding standards, and notes about specific components. +If you wish to build the Arvados documentation from a local git clone, see +[doc/README.textile](doc/README.textile) for instructions. + # Pull requests The preferred method for making contributions is through Github pull requests. @@ -39,17 +43,18 @@ The preferred method for making contributions is through Github pull requests. This is the general contribution process: 1. Fork the Arvados repository using the Github "Fork" button -2. Clone your fork, do your development, commit changes to your fork. +2. Clone your fork, make your changes, commit to your fork. 3. Every commit message must have a DCO sign-off and every file must have a SPDX license (see below). -4. When your fork is ready, through Github, Create a Pull Request against `arvados:master` -5. Notify the core team through the [Arvados development -channel](https://gitter.im/arvados/development) (or other means, such as email) about your pull request. -6. A member of the core team will review the pull request. They may have questions or comments, or request changes. -7. When the contribution is ready, a member of the core team will +4. Add yourself to the [AUTHORS](AUTHORS) file +5. When your fork is ready, through Github, Create a Pull Request against `arvados:master` +6. Notify the core team about your pull request through the [Arvados development +channel](https://gitter.im/arvados/development) or by other means. +7. A member of the core team will review the pull request. They may have questions or comments, or request changes. +8. When the contribution is ready, a member of the core team will merge the pull request into the master branch, which will automatically resolve the pull request. -The Arvados project does not require a contributor agreement in advance, but does require each commit message include a [Developer Certificate of Origin.](https://dev.arvados.org/projects/arvados/wiki/Developer_Certificate_Of_Origin . Please ensure *every git commit message* includes `Arvados-DCO-1.1-Signed-off-by`. If you have already made commits without it, fix them with `git commit --amend` or `git rebase`. +The Arvados project does not require a contributor agreement in advance, but does require each commit message include a [Developer Certificate of Origin](https://dev.arvados.org/projects/arvados/wiki/Developer_Certificate_Of_Origin). Please ensure *every git commit message* includes `Arvados-DCO-1.1-Signed-off-by`. If you have already made commits without it, fix them with `git commit --amend` or `git rebase`. The Developer Certificate of Origin line looks like this: diff --git a/README.md b/README.md index dcd19c497e..cb87862fb9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | [Installing Arvados](https://doc.arvados.org/install/index.html) | [Installing Client SDKs](https://doc.arvados.org/sdk/index.html) | [Report a bug](https://dev.arvados.org/projects/arvados/issues/new) | [Development and Contributing](CONTRIBUTING.md) - + [Arvados](https://arvados.org) is a free software distributed computing platform for bioinformatics, data science, and high throughput analysis of massive data @@ -22,7 +22,7 @@ Arvados consists of: * Related services and components including a web workbench for managing files and compute jobs, REST APIs, SDKs, and other tools. -## Quick start +# Quick start To try out Arvados on your local workstation, you can use Arvbox, which provides Arvados components pre-installed in a Docker container (requires @@ -37,15 +37,15 @@ In this mode you will only be able to connect to Arvbox from the same host. To configure Arvbox to be accessible over a network and for other options see http://doc.arvados.org/install/arvbox.html for details. -## Documentation +# Documentation -Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html) and +Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html), [Administrator documentation](https://doc.arvados.org/admin/index.html) and [API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/ If you wish to build the Arvados documentation from a local git clone, see -doc/README.textile for instructions. +[doc/README.textile](doc/README.textile) for instructions. -## Community +# Community [![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -59,15 +59,16 @@ channel at [gitter.im](https://gitter.im) is used to coordinate development. The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados) is used to announce new versions and other news. -## Reporting bugs +# Reporting bugs -[Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on the [dev.arvados.org Redmine site](https://dev.arvados.org). +[Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org). -## Development and Contributing +# Development and Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project. +See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project. -## Licensing +The [development road map](https://dev.arvados.org/issues/gantt?utf8=%E2%9C%93&set_filter=1&gantt=1&f%5B%5D=project_id&op%5Bproject_id%5D=%3D&v%5Bproject_id%5D%5B%5D=49&f%5B%5D=&zoom=1) outlines some of the project priorities over the next twelve months. -Arvados is Free Software. See COPYING for information about Arvados Free -Software licenses. +# Licensing + +Arvados is Free Software. See [COPYING](COPYING) for information about the open source licenses used in Arvados. -- 2.30.2