Skip to content

Commit e1c1277

Browse files
authored
Merge pull request #233 from AR21SM/Better
Added Contribution workflow for new users , two local preview
1 parent 681965c commit e1c1277

File tree

1 file changed

+64
-4
lines changed

1 file changed

+64
-4
lines changed

README.md

+64-4
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,58 @@ Please contribute ideas, questions, and discussions for content or enhancements
1616

1717
### Problems or Tracking of Work Items from Ideas, Questions, or Discussions
1818

19-
Please add issues on [the github issue tracker](https://github.com/numfocus/DISCOVER-Cookbook/discussions).
19+
Please add issues on [the GitHub issue tracker](https://github.com/numfocus/DISCOVER-Cookbook/issues).
2020

2121
### Content and Design
2222

2323
While content is the heart of the project, the quality of the content needs to remain high. Due to a high volume of generated text being submitted for review, content takes longer to review and approve. We value these contributions but just understand that it will take time to add. Please start an idea in the discussions, then move to making an issue once there is approval for the content to be added to the book. After that issue is made we feel free to open [a pull request](https://github.com/numfocus/DISCOVER-Cookbook/pulls) against the repository to begin the review process.
2424

2525
### Bug fixes
2626

27-
For issues with other elements of the book, first make sure an issue is open and tracking can occur on the issue. Then open a a pull request](https://github.com/numfocus/DISCOVER-Cookbook/pulls).
27+
For issues with other elements of the book, first make sure an issue is open and tracking can occur on the issue. Then open a a [pull request](https://github.com/numfocus/DISCOVER-Cookbook/pulls).
2828

29-
### See Also
3029

31-
For more information, see the `contributing.md` file with a fuller guide on how to contribute.
30+
### Contribution Workflow
31+
32+
To contribute changes:
33+
34+
1. **Fork the Repository**: Click the "Fork" button at the top-right of this repository's GitHub page to create a copy in your account.
35+
36+
2. **Clone Your Fork**:
37+
```sh
38+
git clone https://github.com/your-username/DISCOVER-Cookbook.git
39+
cd DISCOVER-Cookbook
40+
```
41+
42+
3. **Create a New Branch**:
43+
```sh
44+
git checkout -b your-branch-name
45+
```
46+
47+
4. **Make Changes**:
48+
- Edit files in your preferred editor
49+
- Build and verify your changes locally using the [build instructions](#how-to-run-the-book-locally) below
50+
51+
5. **Test Locally**: Build the book and view your changes:
52+
```sh
53+
jupyter-book build DISCOVER
54+
python -m http.server 8000 --directory DISCOVER/_build/html/
55+
```
56+
Visit [`http://localhost:8000`](http://localhost:8000) in your browser to verify changes.
57+
58+
6. **Commit and Push**:
59+
```sh
60+
git add .
61+
git commit -m "Description of your changes"
62+
git push origin your-branch-name
63+
```
64+
65+
7. **Open a Pull Request**: Navigate to your fork on GitHub, select your branch, and click "New Pull Request". Provide a clear description of your changes.
66+
67+
68+
### For More Information
69+
70+
See the `contributing.md` for a detailed guide on how to contribute.
3271

3372

3473
## How to run the book locally
@@ -71,6 +110,27 @@ pip install -r requirements.txt
71110
``` sh
72111
jupyter-book build DISCOVER
73112
```
113+
### View Locally
114+
After building, you can view the book in one of the following ways:
115+
116+
#### **Option 1: Using a Local Server**
117+
Run the following command to start a local server:
118+
```sh
119+
python -m http.server 8000 --directory DISCOVER/_build/html/
120+
```
121+
Then, open [`http://localhost:8000`](http://localhost:8000) in your browser.
122+
123+
#### **Option 2: Opening the File Directly**
124+
Alternatively, you can open the book directly by navigating to:
125+
```
126+
DISCOVER/_build/html/index.html
127+
```
128+
and opening it in your browser.
129+
130+
> **Note:** Make sure you have built the book again before accessing it.
131+
132+
133+
74134

75135
## Contributors ✨
76136

0 commit comments

Comments
 (0)