Updates for the switch from BEP-16 to BEP-24 (#2641)
Signed-off-by: Troy McConaghy <troy@bigchaindb.com>
This commit is contained in:
parent
20a59a9640
commit
835fdfcf59
|
@ -1,9 +0,0 @@
|
||||||
<!---
|
|
||||||
Copyright BigchainDB GmbH and BigchainDB contributors
|
|
||||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
|
||||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
|
||||||
--->
|
|
||||||
|
|
||||||
# How to Handle External Pull Requests
|
|
||||||
|
|
||||||
See [BEP-16](https://github.com/bigchaindb/BEPs/tree/master/16).
|
|
|
@ -2,10 +2,12 @@
|
||||||
|
|
||||||
## Copyrights
|
## Copyrights
|
||||||
|
|
||||||
Except as noted in the **Exceptions** section below, for all code and documentation in this repository, BigchainDB GmbH ("We") either:
|
For all the code and documentation in this repository, the copyright is owned by one or more of the following:
|
||||||
|
|
||||||
1. owns the copyright, or
|
- BigchainDB GmbH
|
||||||
2. owns the right to sublicense it under any license (because all external contributors must agree to a Contributor License Agreement).
|
- A BigchainDB contributor who agreed to a BigchainDB Contributor License Agreement (CLA) with BigchainDB GmbH. (See [BEP-16](https://github.com/bigchaindb/BEPs/tree/master/16).)
|
||||||
|
- A BigchainDB contributor who signed off on the Developer Certificate of Origin (DCO) for all their contributions. (See [BEP-24](https://github.com/bigchaindb/BEPs/tree/master/24).)
|
||||||
|
- (Rarely, see the **Exceptions Section** below) A third pary who licensed the code in question under an open source license.
|
||||||
|
|
||||||
## Code Licenses
|
## Code Licenses
|
||||||
|
|
||||||
|
|
|
@ -49,7 +49,6 @@ extensions = [
|
||||||
|
|
||||||
try:
|
try:
|
||||||
remove('cross-project-policies/code-of-conduct.md')
|
remove('cross-project-policies/code-of-conduct.md')
|
||||||
remove('cross-project-policies/shared-workspace.md')
|
|
||||||
remove('cross-project-policies/release-process.md')
|
remove('cross-project-policies/release-process.md')
|
||||||
remove('cross-project-policies/python-style-guide.md')
|
remove('cross-project-policies/python-style-guide.md')
|
||||||
except:
|
except:
|
||||||
|
@ -62,9 +61,6 @@ def get_old_new(url, old, new):
|
||||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/CODE_OF_CONDUCT.md',
|
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/CODE_OF_CONDUCT.md',
|
||||||
'CODE_OF_CONDUCT.md', 'cross-project-policies/code-of-conduct.md')
|
'CODE_OF_CONDUCT.md', 'cross-project-policies/code-of-conduct.md')
|
||||||
|
|
||||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/BEPs/master/6/README.md',
|
|
||||||
'README.md', 'cross-project-policies/shared-workspace.md')
|
|
||||||
|
|
||||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/RELEASE_PROCESS.md',
|
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/RELEASE_PROCESS.md',
|
||||||
'RELEASE_PROCESS.md', 'cross-project-policies/release-process.md')
|
'RELEASE_PROCESS.md', 'cross-project-policies/release-process.md')
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,6 @@ Policies
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
code-of-conduct
|
code-of-conduct
|
||||||
shared-workspace
|
|
||||||
python-style-guide
|
python-style-guide
|
||||||
JavaScript Style Guide <https://github.com/ascribe/javascript>
|
JavaScript Style Guide <https://github.com/ascribe/javascript>
|
||||||
release-process
|
release-process
|
||||||
|
|
|
@ -65,6 +65,14 @@ Set Up Your Local Machine. Here's How.
|
||||||
latest ``pip``, ``wheel`` and ``setuptools`` and put them inside the new virtualenv.
|
latest ``pip``, ``wheel`` and ``setuptools`` and put them inside the new virtualenv.
|
||||||
|
|
||||||
|
|
||||||
|
Before You Start Writing Code
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
Read `BEP-24 <https://github.com/bigchaindb/BEPs/tree/master/24>`_
|
||||||
|
so you know what to do to ensure that your changes (i.e. your future pull request) can be merged.
|
||||||
|
It's easy and will save you some hassle later on.
|
||||||
|
|
||||||
|
|
||||||
Start Writing Code
|
Start Writing Code
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
|
@ -140,28 +148,9 @@ Codecov gets its configuration from the file `codeocov.yaml <https://github.com/
|
||||||
`docs.codecov.io <https://docs.codecov.io/v4.3.6/docs/codecov-yaml>`_. Codecov might also use ``setup.cfg``.
|
`docs.codecov.io <https://docs.codecov.io/v4.3.6/docs/codecov-yaml>`_. Codecov might also use ``setup.cfg``.
|
||||||
|
|
||||||
|
|
||||||
First-Time Pull Requests from External Users
|
|
||||||
--------------------------------------------
|
|
||||||
|
|
||||||
First-time pull requests from external users who haven't contributed before will get blocked by the requirement to agree to the
|
|
||||||
BigchainDB Contributor License Agreement (CLA). It doesn't take long to agree to it. Go to
|
|
||||||
`https://www.bigchaindb.com/cla/ <https://www.bigchaindb.com/cla/>`_ and:
|
|
||||||
|
|
||||||
- Select the CLA you want to agree to (for individuals or for a whole company)
|
|
||||||
- Fill in the form and submit it
|
|
||||||
- Wait for an email from us with the next step. There is only one: copying a special block of text to GitHub.
|
|
||||||
|
|
||||||
|
|
||||||
Merge!
|
Merge!
|
||||||
------
|
------
|
||||||
|
|
||||||
Ideally, we like your PR and merge it right away. We don't want to keep you waiting.
|
Ideally, we like your PR and merge it right away. We don't want to keep you waiting.
|
||||||
|
|
||||||
If we want to make changes, we'll do them in a follow-up PR.
|
If we want to make changes, we'll do them in a follow-up PR.
|
||||||
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
You are awesome. Do you want a job? `Apply! <https://github.com/bigchaindb/org/tree/master/jobs>`_ Berlin is great. If you got this far, we'd be happy to consider you joining our team. Look at these `Unsplash photos of Berlin <https://unsplash.com/search/photos/berlin>`_. So nice.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue