Contributing

[!NOTE] These instructions are for general student contributions. IEEE members should branch and commit directly to this repository with their personal GitHub account.

Fork the Repository

  • Fork the Repository: Navigate to the wiki repository on GitHub and fork it to your personal GitHub account.
  • Clone the Fork: Clone your forked repository to your local machine

Adding a Class

  • Create a new markdown document in _posts/ with a title with the format YYYY-MM-DD-eceXXXX.md.
    • YYYY-MM-DD is the date of creation
    • XXXX is the course code
  • Fill out the header information as shown in the ECE 2300 page.

[!IMPORTANT] Make sure to fill out the categories field, this is how the classes are sorted and displayed on the homepage.

  • Save, commit, and push to the page branch

Editing a Class

  • Edit one of the class files under _posts. Update the date in the file name to the date of the edit
  • Our pages support MathJax (a subset of LaTeX) outside the front matter section of class pages. See the ECE 3250 page for an example.

Test your Changes

  1. Install Docker. Follow the installation guide per your operating system.

  2. Build the Docker image

      docker compose build

  3. Run the site

      docker compose up

    Look for the Server address: field near the end of the command’s output. You can view the site by pasting that URL into a web browser of your choice. It is generally http://localhost:4000/wiki/.

    [!TIP] The local site will update automatically as you edit the code–just make sure to reload the page!

Submit a Pull Request

  • Open a Pull Request: After pushing your changes to your fork, go to the original wiki repository
  • Click the “Compare & pull request” button, which will appear when GitHub detects changes between your fork and the original repository
  • Submit the PR: Provide a clear description of the changes you made, explaining the purpose of your contributions, and then submit the pull request

Review Process

  • A project maintainer will review your pull request. If it meets the contribution guidelines, it will be merged into the main repository
  • Once merged, your changes will automatically be deployed by GitHub Pages, and you can view them live on the wiki site!