Skip to content

Commit

Permalink
Rename default branch to main
Browse files Browse the repository at this point in the history
  • Loading branch information
pjsier committed Jun 23, 2020
1 parent 16c4c48 commit c6771d5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ We hope that working with us will fill experience gaps (like using git/GitHub, w
## Ready to code with us?

1. [Fill out this form](https://airtable.com/shrRv027NLgToRFd6) to join our Slack channel and meet the community.
2. Read about [how we collaborate](https://github.com/City-Bureau/city-scrapers/blob/master/CONTRIBUTING.md) and review our [Code of Conduct](https://github.com/City-Bureau/city-scrapers/blob/master/CODE_OF_CONDUCT.md).
2. Read about [how we collaborate](https://github.com/City-Bureau/city-scrapers/blob/main/CONTRIBUTING.md) and review our [Code of Conduct](https://github.com/City-Bureau/city-scrapers/blob/main/CODE_OF_CONDUCT.md).
3. Check out our [documentation](https://cityscrapers.org/docs/development/), and get started with [Installation](https://cityscrapers.org/docs/development/#installation) and [Contributing a spider](https://cityscrapers.org/docs/development/#contribute).

We ask all new contributors to start by writing a spider and its documentation or fixing a bug in an existing one in order to gain familiarity with our code and culture. Reach out on Slack for support if you need it.
Expand Down
4 changes: 2 additions & 2 deletions docs/_docs/03-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@ Define a process for lead staff/volunteers at each meeting. Our Coding Session S

### Developing a Code of Conduct

This step is often overlooked but often critical to success. Define a Code of Conduct that all coding community agree to abide by throughout their time on the project. The [Contributor Covenant](https://www.contributor-covenant.org/){:target="\_blank"} inspired an early mission for the open-membership, open-source City Scrapers project, outlined in the project [README file](https://github.com/City-Bureau/city-scrapers/blob/master/README.md){:target="\_blank"} located on GitHub. In addition to the Covenant, this document states that "The City Bureau Labs community welcomes contributions from everyone. We prioritize learning and leadership opportunities for under-represented individuals in tech and journalism.
This step is often overlooked but often critical to success. Define a Code of Conduct that all coding community agree to abide by throughout their time on the project. The [Contributor Covenant](https://www.contributor-covenant.org/){:target="\_blank"} inspired an early mission for the open-membership, open-source City Scrapers project, outlined in the project [README file](https://github.com/City-Bureau/city-scrapers/blob/main/README.md){:target="\_blank"} located on GitHub. In addition to the Covenant, this document states that "The City Bureau Labs community welcomes contributions from everyone. We prioritize learning and leadership opportunities for under-represented individuals in tech and journalism.

We hope that working with us will fill experience gaps (like using git/github, working with data, or having your ideas taken seriously), so that more under-represented people will become decision-makers in both our community and Chicago's tech and media scenes at large."

Here's the [Chicago City Scrapers Code of Conduct](https://github.com/City-Bureau/city-scrapers/blob/master/CODE_OF_CONDUCT.md){:target="\_blank"} as an example (feel free to adapt as needed).
Here's the [Chicago City Scrapers Code of Conduct](https://github.com/City-Bureau/city-scrapers/blob/main/CODE_OF_CONDUCT.md){:target="\_blank"} as an example (feel free to adapt as needed).

### Reward your team

Expand Down
8 changes: 4 additions & 4 deletions docs/_docs/04-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The best way to familiarize yourself with the code base is to build a spider. Fo

### Familiarize yourself with how we work

Please read the project's [`CONTRIBUTING.md`](https://github.com/City-Bureau/city-scrapers/blob/master/CONTRIBUTING.md){:target="\_blank"} file to learn about how we use GitHub to manage the project and our pull request policy.
Please read the project's [`CONTRIBUTING.md`](https://github.com/City-Bureau/city-scrapers/blob/main/CONTRIBUTING.md){:target="\_blank"} file to learn about how we use GitHub to manage the project and our pull request policy.

### Spider Setup

Expand Down Expand Up @@ -314,11 +314,11 @@ You generally want to verify that a spider:

If your ready to submit your code to the project, you should create a pull request on GitHub. You can do this as early as you would like in order to get feedback from others working on the project.

When you go to open a pull request, you'll see a template with details pre-populated including a checklist of tasks to complete. Fill out the information as best you can (it's alright if you can't check everything off yet). It's designed to provide some reminders for tasks to complete as well as making review easier. You can use the rest of the description to explain anything you'd like a reviewer to know about the code. See [CONTRIBUTING.md](https://github.com/City-Bureau/city-scrapers/blob/master/CONTRIBUTING.md){:target="\_blank"} for more details.
When you go to open a pull request, you'll see a template with details pre-populated including a checklist of tasks to complete. Fill out the information as best you can (it's alright if you can't check everything off yet). It's designed to provide some reminders for tasks to complete as well as making review easier. You can use the rest of the description to explain anything you'd like a reviewer to know about the code. See [CONTRIBUTING.md](https://github.com/City-Bureau/city-scrapers/blob/main/CONTRIBUTING.md){:target="\_blank"} for more details.

### `Meeting` Items

The `Meeting` items you need to return are derived from Scrapy's [`Item` classes](https://docs.scrapy.org/en/latest/topics/items.html). The original source can be found in the [`city_scrapers_core` package](https://github.com/City-Bureau/city-scrapers-core/blob/master/city_scrapers_core/items.py).
The `Meeting` items you need to return are derived from Scrapy's [`Item` classes](https://docs.scrapy.org/en/latest/topics/items.html). The original source can be found in the [`city_scrapers_core` package](https://github.com/City-Bureau/city-scrapers-core/blob/main/city_scrapers_core/items.py).

A Scrapy `Item` mostly functions like a normal Python `dict`. You can create a `Meeting` Item with Python keyword arguments and also set values after it's created with Python's general `dict` syntax:

Expand Down Expand Up @@ -440,4 +440,4 @@ Legistar is a software platform provided by Granicus that many governments use t

### ASP.NET Sites

ASP.NET sites can be a challenge because they're often inconsistent and require maintaining a level of state across requests. You can see an example of handling this behavior in the [`cuya_administrative_rules`](https://github.com/City-Bureau/city-scrapers-cle/blob/master/city_scrapers/spiders/cuya_administrative_rules.py) spider.
ASP.NET sites can be a challenge because they're often inconsistent and require maintaining a level of state across requests. You can see an example of handling this behavior in the [`cuya_administrative_rules`](https://github.com/City-Bureau/city-scrapers-cle/blob/main/city_scrapers/spiders/cuya_administrative_rules.py) spider.
6 changes: 3 additions & 3 deletions docs/_docs/setuphelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ You can see your existing remotes as well by running `git remote -v`.
$ git fetch upstream
```

\3. Make sure you are in the branch you hope to merge changes into (typically your `master` branch), then merge the changes in from the `upstream/master` branch.
\3. Make sure you are in the branch you hope to merge changes into (in our case the `main` branch), then merge the changes in from the `upstream/main` branch.

```shell
$ git checkout master
$ git merge upstream/master
$ git checkout main
$ git merge upstream/main
```

\4. The final step is to update your fork on Github with the changes from the original repository by running `git push`.
Expand Down

0 comments on commit c6771d5

Please sign in to comment.