You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by bm...@apache.org on 2015/04/24 01:16:38 UTC
[1/2] mesos git commit: Added a document for engineering principles
and practices.
Repository: mesos
Updated Branches:
refs/heads/bmahler_documentation [created] af742b2a0
Added a document for engineering principles and practices.
Review: https://reviews.apache.org/r/32999
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/d52daefd
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/d52daefd
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/d52daefd
Branch: refs/heads/bmahler_documentation
Commit: d52daefdeddf5335495da1d30ec2b14f0f09e625
Parents: 7d0496f
Author: Benjamin Mahler <be...@gmail.com>
Authored: Wed Apr 8 17:07:26 2015 -0700
Committer: Benjamin Mahler <be...@gmail.com>
Committed: Thu Apr 23 16:05:34 2015 -0700
----------------------------------------------------------------------
docs/engineering-principles-and-practices.md | 33 +++++++++++++++++++++++
docs/home.md | 1 +
2 files changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/d52daefd/docs/engineering-principles-and-practices.md
----------------------------------------------------------------------
diff --git a/docs/engineering-principles-and-practices.md b/docs/engineering-principles-and-practices.md
new file mode 100644
index 0000000..6babb92
--- /dev/null
+++ b/docs/engineering-principles-and-practices.md
@@ -0,0 +1,33 @@
+---
+layout: documentation
+---
+
+# Engineering Principles and Practices
+
+This document is an attempt to capture a shared set of values for the project.
+Many companies rely on Mesos as a foundational layer of their software
+infrastructure and it is imperative that we ship **robust, high quality**
+code. We aim to foster a culture where we can trust and rely upon the work of
+the community.
+
+The following are some of the aspirational principles and practices that
+guide us:
+
+1. We value **craftsmanship**: code should be easy to read and understand,
+ should be written with high attention to detail, and should be consistent
+ in its style. Code is written for humans to read and maintain!
+2. We value **resiliency**: our system must be highly-available, stable, and
+ backwards-compatible. We must consider the implications of failures.
+3. We value **accountability**: we own and support our software, and are
+ accountable for improving it, fixing issues, and learning from our mistakes.
+4. We value **design and code review**: review helps us maintain a high
+ quality system architecture and high quality code, it also helps us mentor
+ new contributors, learn to collaborate more effectively, and reduce the
+ amount of mistakes.
+5. We value **automated testing**: automated testing allows us to iterate and
+ refactor in our large codebase, while verifying correctness and preventing
+ regression.
+6. We value **benchmarking**: benchmarking allows us to identify the right
+ locations to target performance improvements. It also allows us to iterate
+ and refactor in our large codebase, while observing the performance
+ implications.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/mesos/blob/d52daefd/docs/home.md
----------------------------------------------------------------------
diff --git a/docs/home.md b/docs/home.md
index 641ee8f..10dbbd4 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -43,6 +43,7 @@ layout: documentation
* [Reporting an Issue, Improvement, or Feature](/documentation/latest/reporting-a-bug/) for getting started with JIRA.
* [Submitting a Patch](/documentation/latest/submitting-a-patch/) for getting started with ReviewBoard, and our tooling around it.
+* [Engineering Principles and Practices](/documentation/latest/engineering-principles-and-practices/) to serve as a shared set of project-level values for the community.
* [Effective Code Reviewing](/documentation/latest/committers-guide/) guidelines, tips, and learnings for how to do effective code reviews.
* [Committing](/documentation/latest/committing/) guidelines for committing changes.
* [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
Re: [1/2] mesos git commit: Added a document for engineering
principles and practices.
Posted by Benjamin Mahler <be...@gmail.com>.
Accidentally pushed my branch, apologies.
On Thu, Apr 23, 2015 at 4:16 PM, <bm...@apache.org> wrote:
> Repository: mesos
> Updated Branches:
> refs/heads/bmahler_documentation [created] af742b2a0
>
>
> Added a document for engineering principles and practices.
>
> Review: https://reviews.apache.org/r/32999
>
>
> Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
> Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/d52daefd
> Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/d52daefd
> Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/d52daefd
>
> Branch: refs/heads/bmahler_documentation
> Commit: d52daefdeddf5335495da1d30ec2b14f0f09e625
> Parents: 7d0496f
> Author: Benjamin Mahler <be...@gmail.com>
> Authored: Wed Apr 8 17:07:26 2015 -0700
> Committer: Benjamin Mahler <be...@gmail.com>
> Committed: Thu Apr 23 16:05:34 2015 -0700
>
> ----------------------------------------------------------------------
> docs/engineering-principles-and-practices.md | 33 +++++++++++++++++++++++
> docs/home.md | 1 +
> 2 files changed, 34 insertions(+)
> ----------------------------------------------------------------------
>
>
>
> http://git-wip-us.apache.org/repos/asf/mesos/blob/d52daefd/docs/engineering-principles-and-practices.md
> ----------------------------------------------------------------------
> diff --git a/docs/engineering-principles-and-practices.md b/docs/
> engineering-principles-and-practices.md
> new file mode 100644
> index 0000000..6babb92
> --- /dev/null
> +++ b/docs/engineering-principles-and-practices.md
> @@ -0,0 +1,33 @@
> +---
> +layout: documentation
> +---
> +
> +# Engineering Principles and Practices
> +
> +This document is an attempt to capture a shared set of values for the
> project.
> +Many companies rely on Mesos as a foundational layer of their software
> +infrastructure and it is imperative that we ship **robust, high quality**
> +code. We aim to foster a culture where we can trust and rely upon the
> work of
> +the community.
> +
> +The following are some of the aspirational principles and practices that
> +guide us:
> +
> +1. We value **craftsmanship**: code should be easy to read and understand,
> + should be written with high attention to detail, and should be
> consistent
> + in its style. Code is written for humans to read and maintain!
> +2. We value **resiliency**: our system must be highly-available, stable,
> and
> + backwards-compatible. We must consider the implications of failures.
> +3. We value **accountability**: we own and support our software, and are
> + accountable for improving it, fixing issues, and learning from our
> mistakes.
> +4. We value **design and code review**: review helps us maintain a high
> + quality system architecture and high quality code, it also helps us
> mentor
> + new contributors, learn to collaborate more effectively, and reduce the
> + amount of mistakes.
> +5. We value **automated testing**: automated testing allows us to iterate
> and
> + refactor in our large codebase, while verifying correctness and
> preventing
> + regression.
> +6. We value **benchmarking**: benchmarking allows us to identify the right
> + locations to target performance improvements. It also allows us to
> iterate
> + and refactor in our large codebase, while observing the performance
> + implications.
> \ No newline at end of file
>
> http://git-wip-us.apache.org/repos/asf/mesos/blob/d52daefd/docs/home.md
> ----------------------------------------------------------------------
> diff --git a/docs/home.md b/docs/home.md
> index 641ee8f..10dbbd4 100644
> --- a/docs/home.md
> +++ b/docs/home.md
> @@ -43,6 +43,7 @@ layout: documentation
>
> * [Reporting an Issue, Improvement, or
> Feature](/documentation/latest/reporting-a-bug/) for getting started with
> JIRA.
> * [Submitting a Patch](/documentation/latest/submitting-a-patch/) for
> getting started with ReviewBoard, and our tooling around it.
> +* [Engineering Principles and
> Practices](/documentation/latest/engineering-principles-and-practices/) to
> serve as a shared set of project-level values for the community.
> * [Effective Code Reviewing](/documentation/latest/committers-guide/)
> guidelines, tips, and learnings for how to do effective code reviews.
> * [Committing](/documentation/latest/committing/) guidelines for
> committing changes.
> * [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
>
>
[2/2] mesos git commit: Fixed a bad link in the documentation home.
Posted by bm...@apache.org.
Fixed a bad link in the documentation home.
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/af742b2a
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/af742b2a
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/af742b2a
Branch: refs/heads/bmahler_documentation
Commit: af742b2a04d368df83f7452febd7f27e3c020ac9
Parents: d52daef
Author: Benjamin Mahler <be...@gmail.com>
Authored: Thu Apr 23 16:16:29 2015 -0700
Committer: Benjamin Mahler <be...@gmail.com>
Committed: Thu Apr 23 16:16:29 2015 -0700
----------------------------------------------------------------------
docs/home.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/af742b2a/docs/home.md
----------------------------------------------------------------------
diff --git a/docs/home.md b/docs/home.md
index 10dbbd4..db119d7 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -44,7 +44,7 @@ layout: documentation
* [Reporting an Issue, Improvement, or Feature](/documentation/latest/reporting-a-bug/) for getting started with JIRA.
* [Submitting a Patch](/documentation/latest/submitting-a-patch/) for getting started with ReviewBoard, and our tooling around it.
* [Engineering Principles and Practices](/documentation/latest/engineering-principles-and-practices/) to serve as a shared set of project-level values for the community.
-* [Effective Code Reviewing](/documentation/latest/committers-guide/) guidelines, tips, and learnings for how to do effective code reviews.
+* [Effective Code Reviewing](/documentation/latest/effective-code-reviewing/) guidelines, tips, and learnings for how to do effective code reviews.
* [Committing](/documentation/latest/committing/) guidelines for committing changes.
* [C++ Style Guide](/documentation/latest/mesos-c++-style-guide/)
* [Development Roadmap](/documentation/latest/mesos-roadmap/)