Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

21 lines (11 loc) · 2.01 KB

Contributing to this USNCO Problem Archive

First off, thanks for taking the time to contribute! 💓 💯

The following is a set of guidelines for contributing to this repository. It is currently still under development, so if you have any suggestions, feel free to add them in a pull request. These are guidelines, not hard and fast laws, so please exercise your best judgement and generally be respectful and nice. Additionally, note that this repository is more to store the products of code (i.e. the images parsed from the USNCO) rather than the code itself. Hence, issues with problems and solutions are likely to be prioritized above issues with the codebase.

Below are some ways that you can contribute to this repository:

🐛 Bug Reports

If you see a bug, make sure to raise an issue in the issues section. Afterwards, it will be triaged and addressed appropriately. (To do this, click on the issues tab, then click the green "New Issue" button and describe your problem).

New: if some of the images for tests are rendered improperly, but you don't want to make a new issue, there is now a Google Form so that you can easily submit small image bugfixes. Link: https://forms.gle/XCDiFpm3AQoeniSr8. You can identify bugs (to put into issues) or to upload image bugfixes.

🧪 New Problems

If you want to expand the problemset with other chemistry problems, be that your own or other exams (such as Chinese Chemistry Olympiad or IChO prep and IChO problems) open an issue and tag it with the 'expansions' tag. Then, if you wish to do it yourself note that in the issue description, and open a pull request to do so. If you contribute major expansions to problems or code I will make sure to credit you for that in the README.md!

👨‍💻 Additional Code

If you want to add more code for different purposes, feel free to open a pull request to contribute. While code quality currently is not the best, I hope that the code in this repository will soon(TM) follow checkstyle and spotless standards.