search

OpenSourceCornell / Spring_2018_WICC_OSC

The Git Workshop for the Spring 2018 WICC and Open Source Cornell Introduction to Open Source event.
1 stars 21 forks source link

readme

WICC & OpenSourceCornell Git Workshop

This is the repository for the WICC & OSC git workshop on Wednesday, March 7, 2018. It contains many Python functions that need to be implemented! Contributing guidelines are laid out below.

Contributing

If you want to implement a specific function, please follow the following steps:

  1. First, comment on the issue for that function you want to implement, so others know you are working on it.
  2. On Github, fork the repository (see this article).
  3. Clone the repository to your local machine (see this article).
  4. Create a new branch with git checkout -b [function-name].
  5. Implement the function, ensuring that the function passes the corresponding test cases (see the Testing section).
  6. Commit you work (using git add [file] and git commit).
  7. Push your commit to your repository on Github (using git push).
  8. Submit a pull request on the WICC & OSC repository, requesting that your code be merged into the repository (see this article).
  9. Wait for your pull request to be merged into master.

Thank you for any contributions!

Testing

To test a specific function, do the following: first, ensure you are in the testing subdirectory by running cd testing from the root of the project. Then, run python [function-name]_test.py to test the code.