-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: reword and restructure content related to devcontainers
- Loading branch information
1 parent
38c0251
commit 3c93f1a
Showing
2 changed files
with
28 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,58 @@ | ||
# Contributing | ||
Welcome! And thank you for your interest in contributing to our project. We use our wonderful [Contributor Covenant](http://contributor-covenant.org/) for our [Code of Conduct](). Please [read it](CODE_OF_CONDUCT.md) before you join our project. | ||
|
||
There are many ways in which you can contribute, beyond writing code. Here's a high-level overview of how you can get involved. | ||
There are many ways in which you can contribute, beyond writing code, for example: | ||
|
||
- [Submit bugs and feature requests](https://github.com/alertbox/bookworm/issues), and help us verify as they are checked in | ||
- Upvote [popular feature requests]() | ||
- Review [source code changes](https://github.com/alertbox/bookworm/pulls) | ||
- Review the [documentation](README.md) and make pull requests for anything from typos to new content | ||
|
||
## Contributing to Source Code | ||
If you are interested in writing code to fix issues, here's a high-level overview of how you can clone the repos and get started. | ||
## Prerequisites | ||
You can avoid local dependency installation as this repository includes a development container. See [@kosalanuwan/devcontainers](https://github.com/kosalanuwan/devcontainers) for the minimal requirements to get started. | ||
|
||
## Build and Run | ||
In order to download necessary tools, see the [@kosalanuwan/devcontainers](https://github.com/kosalanuwan/devcontainers/#readme) repository for the minimal requirements to get started. | ||
|
||
#### Step 1 Getting the source code | ||
First fork the repository so that you can make a Pull Request. Then clone your fork locally: | ||
|
||
```bash | ||
#!/bin/bash | ||
git clone https://github.com/<your-github-account>/bookworm | ||
```zsh | ||
#!/bin/zsh | ||
gh repo clone bookworm | ||
code bookworm/ | ||
``` | ||
|
||
Occasionally you would want to merge changes the upstream repository (the official code repo) with your fork. | ||
|
||
```bash | ||
#!/bin/bash | ||
```zsh | ||
#!/bin/zsh | ||
cd bookworm | ||
git checkout master | ||
git pull https://github.com/bookworm master | ||
git pull https://github.com/alertbox/bookworm master | ||
``` | ||
|
||
#### Step 2 Build and run from the source | ||
First, you want to ensure Docker Desktop is running on your machine and the scripts are executable. See [troubleshooting](#troubleshooting). Then build and run the template locally. | ||
|
||
```sh | ||
#!/bin/bash | ||
cd bookworm | ||
|
||
./preview.sh -n bookworm-preview -p 8004 -v latest | ||
``` | ||
You want to ensure Docker Desktop is running on your machine to open the code in container. | ||
With VS Code: | ||
- Run command: `Rebuild and Reopen in Container` to install local dependencies and required plugins. | ||
- Run task: `build` to generate the static site to ensure. | ||
- Run task: `live-serve` to preview changes locally in watch mode. | ||
|
||
To test the changes, you launch your favorite browser and visit <https://localhost:8004/bookworm/>. | ||
To test the changes, you launch your favorite browser and visit [localhost:8004/bookworm/](http://localhost:8004/bookworm/). | ||
|
||
 | ||
|
||
> Default theme comes with [Pixyll](https://github.com/johno/pixyll). | ||
> Default theme comes with a flavor of [Pixyll](https://github.com/johno/pixyll). | ||
### Pull Requests | ||
## Pull Requests | ||
To enable us to quickly review and accept your pull request, always create one pull request per issue, link the issue in the pull request. Never merge multiple into one unless they all share the same root cause. | ||
|
||
Be sure to follow community guidelines and keep the source code changes as small as possible. Avoid any pure document formatting changes to code that has not been modified otherwise. | ||
|
||
To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment. | ||
|
||
### Publishing | ||
At present, the [Bookworm](https://alertbox.github.io/bookworm/) is only published in following platforms: `GitHub Pages`, `Jekyll Remote Theme`. | ||
## Publishing | ||
At present, the [Bookworm](https://alertbox.github.io/bookworm/) is only published as: `GitHub Pages`, `Jekyll Remote Theme`. | ||
|
||
These `tags` are available: `template | remote_theme` | ||
|
||
### Discussion Etiquette | ||
## Discussion Etiquette | ||
In order to keep the conversations clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times. | ||
|
||
## Thank You | ||
You contributions to OSS projects, large or small, make great projects like `pixyll` possible. Thank you for taking time to contribute. | ||
You contributions to OSS projects, large or small, make great projects like `bookworm` possible. Thank you for taking time to contribute. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters