|
| 1 | +# Contributing to ACM AI's Wiki |
| 2 | + |
| 3 | +Thank you for contributing to the ACM AI Wiki! |
| 4 | + |
| 5 | +Here you will find resources on how to set up, navigate, and contribute to the Wiki. |
| 6 | +### Setting Up |
| 7 | +--- |
| 8 | + |
| 9 | +First, make sure you have [Git](https://git-scm.com/) and [Node.js](https://nodejs.org/en) installed and then clone the repository. Make sure you `cd` into the `website` folder. Before running the website locally for the first time, run `npm i` to install the project's dependancies. Next, run `npm start` to start the website. If it doesn't start, try `npm run build` before starting again. |
| 10 | +### File Structure |
| 11 | +--- |
| 12 | + |
| 13 | +``` |
| 14 | +Year |
| 15 | + |
| 16 | +└── Academic Quarter |
| 17 | + |
| 18 | + └── Workshop Series |
| 19 | + |
| 20 | + ├── Workshop 1 |
| 21 | + |
| 22 | + │ ├── Figures |
| 23 | + |
| 24 | + │ │ ├── Workshop_Header_Dark.png |
| 25 | + |
| 26 | + │ │ └── Workshop_Header_light.png |
| 27 | + |
| 28 | + │ ├── README.md (follow the directions in the file) |
| 29 | + |
| 30 | + │ └── workshopnotebook.ipynb (required) |
| 31 | + |
| 32 | + ├── README.MD (follow the directions in the file) |
| 33 | + |
| 34 | + ├── Workshop_Main_Header_Dark.png |
| 35 | + |
| 36 | + └── Workshop_Main_Header_Light.png |
| 37 | +``` |
| 38 | +### Making Changes |
| 39 | +--- |
| 40 | + |
| 41 | +When contributing to the Wiki, make sure organize workshops by quarter and year. Add your Jupyter Notebook files. Utilize the workshop templates provided and follow the directions provided in the `README` files. Make a pull request when you're done! |
| 42 | +### Adding a Workshop |
| 43 | +--- |
| 44 | + |
| 45 | +Create a new folder with the format `year/term/name` similar to `2025/WI25/test`. Copy the single workshop or workshop series template into the folder. The `README` files will become visible pages, and placing the `.ipynb` workshop notebook file in the folder will display as a subpage. |
| 46 | + |
| 47 | +Fill out the `README.md` template as directed by the comments. Feel free to make changes to the template if necessary. |
| 48 | + |
| 49 | +Note: JSX style comments `{/*comment */}` instead of HTML-style comments `<!-- comment -->` are needed to deploy correctly. |
| 50 | +### Creating a Pull Request |
| 51 | +--- |
| 52 | + |
| 53 | +Creating a pull request starts a development preview build which you can check for accuracy. This should be located in a comment made by the Vercel bot where you can visit the preview. Merging the pull request will make the changes live on the wiki. |
| 54 | +### Example Pull Request |
| 55 | +--- |
| 56 | + |
| 57 | +You can view an example pull request [here](https://github.com/acmucsd/acm-ai-workshops/pull/38) and the corresponding deployment preview [here](https://acm-ai-workshops-git-example-acmucsd.vercel.app/). Note how this pull request created a preview build on Vercel and needs a review to be merged to main. |
| 58 | +### Style Guide |
| 59 | +--- |
| 60 | +Try to follow [Conventional Commits](https://www.conventionalcommits.org/) when making pull requests. |
0 commit comments