This repo is for the official Santa Rosa Junior College Computer Science Club website. Kyle O'Brien is the project manager for this project. We're open to all SRJC students who're interested in contributing. We purposely opted to use only basic web technologies that the barrier of entry is minimal and time commitment. We also use a Git workflow of issues, pull requests, and code review.
Interested in Contributing?
We're more than happy to have students of all experience levels contribute. In fact, beginners are encouraged! We have tasks that encompass all skill levels ranging from new section, photo editing, and content writing.
Here are the steps to begin contributing.
-
Message Kyle O'Brien stating you're interested in contributing. Provide your Github username and your areas of interest.
-
Chose or be assigned an issue to work on. Issues (tasks to be done) can be found in the issues section of the Github repo.
-
Install dependencies. The project requires multiple dependencies. Going about installing these will vary by operating system. The instruction given will assume you're using MacOS. If not, all dependencies have Windows and Linux distributions.
- Git
- Ruby
- Sass
- Python (Ideally Python 3)
- Docker (NOTE: Docker for Windows requires Windows 10 Pro or Enterprise to run. If you're not on either of these, use Docker Toolbox instead.)
- A text editor such as Atom, Sublime, or VSCode.
-
Clone the Github repository locally. Make a new branch with the name the same as or similar to the issue name. Each branch name should start with your first name. EX:
kyle-fix-bootstrap-header. -
Once you're ready for your first commit, push the branch remotely and make a new pull request.
-
Once you're ready, request a code review. If the project manager approves your pull request, merge the branch into master and delete it.
Congratulations! You will have addressed your first issue! Feel free to message any member of the project if you have any questions.
In order to contribute, you should be familiar with at least a few of the technologies used on these projects. While the barrier to entry is low, it still can take time to learn all these technologies at once. Here we've compiled a list of all the technologies used in the project and useful tutorials for learning them.
In order to make development easier, one the project, we use a series of custom make commands. These commands can be found in the Makefile. You execute each command by typing in make x where x is the name of the command while in the project root directory.
(NOTE: make is not recognized by the default Windows Command Prompt or PowerShell. For a native Windows solution, please see the Make Commands (Windows) section bellow)
make run: Runs the python web server. The web page will open in localhost 8000. Requires Python 3.make run-alt: Does the same of the regularmake-runbut supports Python 2.make docker: Build the Docker image with the local changes.make sass: Will compile any changes in the index.scss (sass) file to index.css.make sass-watch: Will run a sass process that will auto compile any changes in the index.scss (sass) file to index.css.
While Windows does have a native Makefile utility, called NMAKE, it can not be ran in the standard Command Prompt or PowerShell, as it is only accessable via a set of .NET developer tools. The easiest way use NMAKE is to run the Developer Command Prompt, which can be accessed with the help of Visual Studio.
(NOTE: This guide is for Windows 10. For older Windows versions, please see this link.)
-
Open up the Start menu and type 'Dev', you should see
Developer Command Prompt for VS(Your version), as one of the top results. -
Once the Developer Command Prompt is open, simply type
nmakein replace ofmaketo execute any Makefile command, including the ones listed above.
IMPORTANT: Though NMAKE can open Makefiles created for Unix-like operating systems (MacOS, Linux, etc.), Command Prompt and the Unix command line can often diver in both formating and commands. This can, in turn, cause numerous errors, so please keep this in mind when using NMAKE. If you are looking for a something a bit "deeper", there are environments that provide UNIX-like commands (including make) for Windows, such as Cygwin, which can also prove to be very powerfull.