From 79d8c1932e7cbb42ef4863ebd11490bb7fd79c0e Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Thu, 13 Feb 2020 17:05:19 -0500 Subject: [PATCH] 16080: Writeup of CONTRIBUTING.md Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 69 +++++++++++++++++++++++++++++++++++++++++++++- COPYING | 4 +++ README.md | 38 ++++++++++++------------- 4 files changed, 90 insertions(+), 23 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 708ce01e05..5345f045ff 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -22,7 +22,7 @@ appearance, body size, age, race, or religion. including those related to food, health, parenting, drugs, and employment. - Deliberate misgendering or use of [dead](https://www.quora.com/What-is-deadnaming/answer/Nancy-C-Walker) or rejected names. - - Gratuitous or off-topic sexual images or behaviour in spaces where they’re not + - Gratuitous or off-topic sexual images or behaviour in spaces where they’re not appropriate. - Physical contact and simulated physical contact (eg, textual descriptions like “\*hug\*” or “\*backrub\*”) without consent or after a request to stop. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56025afe57..28ba118eb7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,70 @@ +[comment]: # (Copyright © The Arvados Authors. All rights reserved.) +[comment]: # () +[comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0) + # Contributing -When making a pull request, please ensure *every git commit message* includes a one-line [Developer Certificate of Origin](https://dev.arvados.org/projects/arvados/wiki/Developer_Certificate_Of_Origin). If you have already made commits without it, fix them with `git commit --amend` or `git rebase`. +Arvados is free software, which means it is free for all to use, learn +from, and improve. We encourage contributions from the community that +improve Arvados for everyone. Some examples of contributions are bug +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. + +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 . + +# Development + +Git repositories for primary development are located at +https://git.arvados.org/ and can also be browsed at +https://dev.arvados.org/projects/arvados/repository . Every push to +the master branch is also mirrored to Github at +https://github.com/arvados/arvados . + +Visit [Hacking Arvados](https://dev.arvados.org/projects/arvados/wiki/Hacking) for +detailed information about setting up an Arvados development +environment, development process, coding standards, and notes about specific components. + +# Pull requests + +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. +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 +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 Developer Certificate of Origin line looks like this: + +``` +Arvados-DCO-1.1-Signed-off-by: Joe Smith +``` + +New files must also include `SPDX-License-Identifier` at the top with one of the three Arvados open source licenses. See [COPYING](COPYING) for details. + +# Continuous integration + +Continuous integration is hosted at https://ci.arvados.org/ + +Currently, external contributers cannot trigger builds. We are investigating integration with Github pull requests for the future. + +[![Build Status](https://ci.arvados.org/buildStatus/icon?job=run-tests)](https://ci.arvados.org/job/run-tests/) + +[![Go Report Card](https://goreportcard.com/badge/github.com/arvados/arvados)](https://goreportcard.com/report/github.com/arvados/arvados) diff --git a/COPYING b/COPYING index 61c31397a0..c549d8a7bb 100644 --- a/COPYING +++ b/COPYING @@ -17,3 +17,7 @@ The full license text for each license is available in this directory: AGPL-3.0: agpl-3.0.txt Apache-2.0: apache-2.0.txt CC-BY-SA-3.0: cc-by-sa-3.0.txt + +As a general rule, code in the sdk/ directory is licensed Apache-2.0, +documentation in the doc/ directory is licensed CC-BY-SA-3.0, and +everything else is licensed AGPL-3.0. \ No newline at end of file diff --git a/README.md b/README.md index 2e2641db30..d95d7dab39 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [comment]: # () [comment]: # (SPDX-License-Identifier: CC-BY-SA-3.0) +[![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 sets. Arvados supports a variety of cloud, cluster and HPC environments. @@ -9,10 +11,11 @@ sets. Arvados supports a variety of cloud, cluster and HPC environments. Arvados consists of: * *Keep*: a petabyte-scale content-addressed distributed storage system for managing and - storing collections of files, accessible via HTTP and FUSE mount. + storing collections of files, accessible via a variety of methods including + Arvados APIs, WebDAV, and FUSE file system mount. -* *Crunch*: a Docker-based cluster and HPC workflow engine designed providing - strong versioning, reproducibilty, and provenance of computations. +* *Crunch*: a Docker-based cloud and HPC workflow engine designed providing + strong versioning, reproducibilty, and provenance of large-scale computations. * Related services and components including a web workbench for managing files and compute jobs, REST APIs, SDKs, and other tools. @@ -34,8 +37,8 @@ http://doc.arvados.org/install/arvbox.html for details. ## Documentation -Complete documentation, including a User Guide, Installation documentation and -API documentation is available at http://doc.arvados.org/ +Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/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. @@ -44,30 +47,23 @@ doc/README.textile for instructions. [![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) -The [arvados community channel](https://gitter.im/arvados/community) +The [Arvados community channel](https://gitter.im/arvados/community) channel at [gitter.im](https://gitter.im) is available for live discussion and support. -The -[Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados) -is a forum for general discussion, questions, and news about Arvados -development. The -[Arvados developer mailing list](http://lists.arvados.org/mailman/listinfo/arvados-dev) -is a forum for more technical discussion, intended for developers and -contributors to Arvados. +The [Arvados developement channel](https://gitter.im/arvados/development) +channel at [gitter.im](https://gitter.im) is used to coordinate development. -## Development +The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados) +is used to announce new versions and other news. -[![Build Status](https://ci.arvados.org/buildStatus/icon?job=run-tests)](https://ci.arvados.org/job/run-tests/) -[![Go Report Card](https://goreportcard.com/badge/github.com/arvados/arvados)](https://goreportcard.com/report/github.com/arvados/arvados) +## Reporting bugs -The Arvados public bug tracker is located at https://dev.arvados.org/projects/arvados/issues +[Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on the [dev.arvados.org Redmine site](https://dev.arvados.org). -Continuous integration is hosted at https://ci.arvados.org/ +## Development and Contributing -Instructions for setting up a development environment and working on specific -components can be found on the -["Hacking Arvados" page of the Arvados wiki](https://dev.arvados.org/projects/arvados/wiki/Hacking). +See [CONTRIBUTING.md](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project. ## Licensing -- 2.30.2