You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by he...@apache.org on 2015/08/10 19:32:55 UTC
[24/50] [abbrv] allura git commit: [#7915] "contributing" cleanup
[#7915] "contributing" cleanup
Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/91870717
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/91870717
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/91870717
Branch: refs/heads/hs/7925
Commit: 91870717e1b2d3b481ece1c8c00ab5d57b392aa7
Parents: ff2fff4
Author: Dave Brondsema <da...@brondsema.net>
Authored: Wed Aug 5 17:37:59 2015 -0400
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Wed Aug 5 17:53:23 2015 -0400
----------------------------------------------------------------------
Allura/docs/development/contributing.rst | 4 +-
Allura/docs/getting_started/installation.rst | 2 +-
CONTRIBUTING | 174 ----------------------
3 files changed, 4 insertions(+), 176 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/91870717/Allura/docs/development/contributing.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/development/contributing.rst b/Allura/docs/development/contributing.rst
index 2dff6ad..a3b8ba4 100644
--- a/Allura/docs/development/contributing.rst
+++ b/Allura/docs/development/contributing.rst
@@ -15,6 +15,8 @@
specific language governing permissions and limitations
under the License.
+.. _contributing:
+
************
Contributing
************
@@ -36,7 +38,7 @@ Installing Allura
-----------------
Before hacking on Allura, you'll need to get an Allura instance up and running
so you can see and test the changes you make. You can install Allura from
-scratch, or by using our pre-built Vagrant image. Instructions for these
+scratch, or by using our Docker container images. Instructions for these
approaches can be found here:
* :ref:`Install from scratch <step-by-step-install>`
http://git-wip-us.apache.org/repos/asf/allura/blob/91870717/Allura/docs/getting_started/installation.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/installation.rst b/Allura/docs/getting_started/installation.rst
index d43d52d..5ad62a7 100644
--- a/Allura/docs/getting_started/installation.rst
+++ b/Allura/docs/getting_started/installation.rst
@@ -220,7 +220,7 @@ Extra
* Ask questions and discuss Allura on the `allura-dev mailing list <http://mail-archives.apache.org/mod_mbox/allura-dev/>`_
* Run the test suite (slow): :code:`$ ALLURA_VALIDATION=none ./run_tests`
* File bug reports at https://forge-allura.apache.org/p/allura/tickets/new/ (login required)
-* Contribute code according to `this guide <https://forge-allura.apache.org/p/allura/wiki/Contributing%20Code/>`_
+* Contribute code according to :ref:`this guide <contributing>`
.. _docker-install:
http://git-wip-us.apache.org/repos/asf/allura/blob/91870717/CONTRIBUTING
----------------------------------------------------------------------
diff --git a/CONTRIBUTING b/CONTRIBUTING
deleted file mode 100644
index 88ae8ce..0000000
--- a/CONTRIBUTING
+++ /dev/null
@@ -1,174 +0,0 @@
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-ABOUT ALLURA
-
-Allura is an open source implementation of a software "forge", a
-web-site that manages source code repositories, bug reports,
-discussions, mailing lists, wiki pages, blogs and more for any
-number of individual projects.
-
-SourceForge.net is running an instance of Allura (aka New Forge, or
-Forge 2.0); and Allura itself is a project managed there:
-
- <https://allura.apache.org/>
-
-The source for Allura is available there from a Git repo under the
-Apache License, Version 2.0.
-
- <http://www.apache.org/licenses/LICENSE-2.0>
-
-Allura is written in Python and leverages a great many existing Python
-packages (see requirements.txt and friends). It comes with tests which
-we run with nose (see <http://somethingaboutorange.com/mrl/projects/nose/1.0.0/>).
-It is extensible in several ways, most importantly via the notion of
-"tools" based on allura.Application; but also with themes,
-authentication, and various other pluggable-APIs.
-
-CONTRIBUTING
-
-Allura is an effort _for_ the community: an open source platform for
-sharing development. We think it should be _of_ the community as well.
-We want to encourage community involvement in development, testing and
-design. We do that with a public git repo, a bug tracker, a discussion
-list and an IRC channel.
-
-
-- REPORTING BUGS
-
-Report bugs to our public tracker at:
-
- <https://forge-allura.apache.org/p/allura/tickets/>
-
-Four things make for a good bug report:
-
- + it's not a duplicate of an existing bug
-
- + it has a clear description of what was expected vs. what actually
- happened and why what actually happened was wrong
-
- + it has a recipe as simple as possible to reproduce it
-
- + it describes the environment in which the bug happens, i.e., your
- os, browser, and browser version; or if you're running your own
- forge -- the relevant details of the host os and supporting tools
-
-Other things that increase the value of a bug report but aren't always
-possible or applicable:
-
- + screen shots
-
- + code (to be added to the automated tests) that tests for the problem
-
- + patches to fix the problem
-
-
-- GETTING THE CODE
-
-The code is self-hosted in a public git repository. Get it by cloning:
-
- git clone https://git-wip-us.apache.org/repos/asf/allura.git allura
-
-- CONTRIBUTING CODE
-
-Develop and test your patches locally and then get them to us in one of
-two ways:
-
- + push your changes up to your 'forked' repo, and from there send us
- a merge request
-
- + attach a patch file to a ticket
-
-Things your patch-sequence must have/do:
-
- + follow PEP-8 <http://www.python.org/dev/peps/pep-0008/> coding
- guidelines
-
- + contain appropriate tests to be added to the automated testing
- machinery
-
- + pass existing tests (and/or fix existing tests that need to change)
-
- + be divided into an appropriate number of commits, one per reasonable
- "chunk" of functionality
-
-Things your patch will have before it can be merged into branch 'dev' or
-'master':
-
- + Discussion either on the mailing list or in the merge request, where
- you submitted it
-
- + Code-review (possibly many times as you re-work your patches in
- response to discussion)
-
-Very small patches might not need much discussion.
-
-
-- CONTRIBUTING TO THE DISCUSSION
-
-We intend to develop "out in the open", which means having a public
-discussion where we talk about new features, submitted patches, bugs,
-direction, and deployment. You can join in the discussion on the
-mailing list:
-
- <http://mail-archives.apache.org/mod_mbox/allura-dev/>
-
-
-- ASKING QUESTIONS
-
-First, is your question already answered in the FAQ?
-
- <https://forge-allura.apache.org/p/allura/wiki/FAQ/>
-
-If not, then the right place to ask is either the mailing list (above)
-or the IRC channel:
-
- <irc://irc.freenode.com:6667/#sourceforge>
-
-
-- OUR DEVELOPMENT MODEL
-
-Our model is a somewhat scaled-down version of how the Git project
-itself is run. We have two main branches
-
- + master: release quality
-
- + dev: integration branch for commits expected to go to master
-
- + feature branches not yet ready for integration testing, starting
- with the two character initials of the author, e.g., db/1368 for Dave
- Brondsema's work on bug [#1368] or wo/contributing for Wolf's work on
- the CONTRIBUTING doc
-
-'master' and 'dev' are stable; they will never be rewound or rebased.
-Feature branches are typically cut from 'dev', and usually rebased to
-'dev' just before they are merged there. In the meanwhile they may be
-rebased or rewound as necessary. Being on 'dev' is not a guarantee that
-a commit will make it to master. Anything that turns out to not
-actually be ready will be reverted.
-
-'dev' will always contain 'master'. Emergency fixes may go directly to
-'master' which would then immediately be merged down into 'dev'.
-
-As we get more contributors and start having "patch-churn", we will
-re-evaluate a three-branch model, like Git. The third branch would be
-'pu' (for "proposed update").
-
-We expect that people deploying the code will deploy from 'master' or
-from a release tag. We expect that people experimenting with the code
-will deploy from 'dev' or from their own feature branches or integration
-branches cut from 'dev'.