https://github.com/palewire/first-pull-request
How to propose changes to open-source software using GitHub pull requests
https://github.com/palewire/first-pull-request
education git github guide pull-requests sphinx training tutorial version-control
Last synced: 6 months ago
JSON representation
How to propose changes to open-source software using GitHub pull requests
- Host: GitHub
- URL: https://github.com/palewire/first-pull-request
- Owner: palewire
- License: gpl-3.0
- Created: 2022-12-08T20:54:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T12:28:41.000Z (about 2 years ago)
- Last Synced: 2024-10-18T09:33:10.470Z (over 1 year ago)
- Topics: education, git, github, guide, pull-requests, sphinx, training, tutorial, version-control
- Language: Makefile
- Homepage: https://palewi.re/docs/first-pull-request/
- Size: 26.3 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
How to propose changes to open-source software using GitHub [pull requests](https://docs.github.com/en/pull-requests)
- Documentation: [palewi.re/docs/first-pull-request](https://palewi.re/docs/first-pull-request/)
- Issues: [https://github.com/palewire/first-pull-request/issues](https://github.com/palewire/first-pull-request/issues)
## Contributing to the docs
The documentation for this site is published via [Sphinx](https://www.sphinx-doc.org/en/master/) and written in [Markdown](https://www.markdownguide.org/) files in the [`docs` directory](/docs/).
An edit there followed by push to the master branch on GitHub will trigger the docs being redeployed to [https://palewi.re/docs/first-pull-request/](https://palewi.re/docs/first-pull-request/).
### Running the docs locally
Fork the repository and clone it to your computer. Then enter the directory and install the dependencies with pipenv.
```bash
pipenv install --dev
```
Start the test server.
```bash
make
```
Visit localhost:8000 in your browser and you should see the site. Edits you make in the `/docs/` folder should show up automatically.