Skip to content

Commit 8f3ece1

Browse files
Docs: Migrated contributing guidelines from Wiki to CONTRIBUTING.md
1 parent 333487d commit 8f3ece1

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

.github/CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
1-
Thank you for your interest in contributing! We work primarily on Github. Please
2-
review the [contributing procedures](https://github.com/pysal/pysal/wiki/GitHub-Standard-Operating-Procedures) so that we can accept your contributions! Alternatively, contact someone in [PySAL's Discord channel](https://discord.gg/BxFTEPFFZn).
1+
# Contributing to PySAL
2+
3+
PySAL moved to the Pull Request model at the 2013 SciPy Conference. Basically, this involves the following components:
4+
5+
1. The organization GitHub account that has the master branch.
6+
2. Releases are made via tags out of master.
7+
8+
A high-level overview of our model is as follows: All work will be submitted via pull requests. Developers will work on branches on their local machines, push these branches to their GitHub repos, and issue a pull request to the organization GitHub account. One of the other developers must review the Pull Request and merge it or, if there are issues, discuss them with the submitter. This ensures developers have a better understanding of the code base and we catch problems before they enter master.
9+
10+
## Initial Setup
11+
12+
1. If you don't have one yet, create your own account on GitHub.
13+
2. Fork `pysal/pysal` into your personal GitHub account.
14+
3. On a laptop/desktop client, clone master from your GitHub account:
15+
```bash
16+
git clone [https://github.com/yourUsername/pysal.git](https://github.com/yourUsername/pysal.git)

0 commit comments

Comments
 (0)