Skip to content

Commit

Permalink
Add link to website README in README and CONTRIBUTING (#3799)
Browse files Browse the repository at this point in the history
  • Loading branch information
kavishsathia committed Aug 21, 2024
1 parent 9e89056 commit e12e00b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Working on your first Pull Request? You can learn how from this free video serie

[How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github)

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/nusmodifications/nusmods/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that contain bugs/enhancements that have a relatively limited scope. This is a great place to get started.
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/nusmodifications/nusmods/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that contain bugs/enhancements that have a relatively limited scope. This is a great place to get started. To run the website locally, refer to this [guide](/website/README.md).

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ We welcome contributors of all skill levels and backgrounds. Our [contribute pag

For developers and designers, our [contributing guide](/CONTRIBUTING.md) will help first-time contributors get started. For more advanced topics, we have an [architecture overview](/ARCHITECTURE.md) that explains how the various projects in this repository fit together.

To run the website locally, refer to this [guide](/website/README.md).

Quite a few of our contributors are students who started contributing to NUSMods with no prior experience. They have since gone on to internships and full-time jobs as software engineers / designers / founders. We are happy to help you get started and learn new skills!

## Community and Support
Expand Down

0 comments on commit e12e00b

Please sign in to comment.