Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 3.3 KB

Contributing

TigerPath is an open source project maintained by and for Princeton students. If you would like to help out, you have come to the right place!

You can contribute in any of a number of ways:

Bug Reports and Feature Requests

This is the easiest way to contribute, and you do not need any technical know-how. Just go to the issues page and tap "New Issue" at the top right of the page.

You can file a Bug Report if you find a problem with the app. To help us find a solution, describe how you found the problem, and, if relevant, provide a screenshot or link (for instance to a relevant department web page) that helps us see the problem.

If you have an idea for how to improve the app, you can also file a Feature Request at the same place. Describe how you envision the app improving and how you think it will help users, including yourself.

If you don't have anything in mind, you can still help by reading through the issues page and adding your thoughts on the issues others have posted. Do you have the same problem they do? Do you like their idea? Do you think there is a better way? Feel free to engage in conversations about the best way to improve TigerPath.

Adding or editing major and certificate requirements

Major, certificate, and departmental data were moved to another repository in December 2022. Visit the repository to learn how to contribute!

Contributing Code

This is only for the more technically savvy among you who would like to take on an extra challenge with the goal of helping to improve the experiences of our student users.

If you would like to implement a new feature, first open an issue so that it can be discussed and we can come to a shared consensus of how this feature will come about.

Second, either start a new feature branch or fork the repository and start a branch there, and implement your new feature in this feature branch. Take a look at the README for some help with setting up an environment with which to test your local changes.

Once you are satisfied with your changes, come back to the TigerPath GitHub and submit a pull request to the master branch of TigerHub (the branch that goes into production).

There we will together discuss your changes and if anything needs to be ammended. If everything looks good, we will then merge your code into the master branch and deploy it to tigerpath.io.

Feel free to reach out to us through GitHub at any point to ask for help with your contributions, or reach out directly by email to Barak Nehoran (netid: bnehoran).

Thanks!

Since this is a project that is maintained and supported by a community of Princeton students, it is only as good as the students contributers would like it to be.

On behalf of the thousands of Princeton students who use TigerPath, thanks for helping to make it a better, more accurate, and more user-friendly tool for ourselves and for the next generation of students.