Chenglin Miao (cmiao7@illinois.edu)
- I am Chenglin Miao, currently pursuing my Master's in Computer Engineering at the University of Illinois Urbana-Champaign. During my graduate and undergraduate studies, I have gained substantial experience, particularly in software development and data science. I previously worked as a Software Developer at the Illinois Fire Service Institute Library, where I was involved in the development of an emergency response website using technologies such as Spring Boot, Vue, and MySQL. Additionally, I served as a Software/Quantitative Developer at ProbQuant, where I worked on trading brokerage solutions and real-time market data analysis. These experiences have honed my technical skills and problem-solving abilities.
- My LinkedIn is located here: https://www.linkedin.com/in/chenglin-miao-569584222/
Luwei Wang(luweiw2@illinois.edu)
- I'm Luwei Wang, a graduate student now enrolled in Industrial Engineering. The main experience of mine is about software development, both front-end and back-end. I'm interested in trading and that's why I'm enrolled in IE421. I'm looking forward to completing the project so that I can both gain experience and enrich my resume.
Xi Teng(xiteng2@illinois.edu)
- I am Xi Teng, a master studnet at MSFE program. The most poprgramming experience I had previously was implementing a semntiment analysis model from github, and perfroming data analysis on the setimental results and stocks' data. I am learning c++, python machine learning thoughout the program.
Xiaoyue Chen (xc53@illinois.edu)
-
I am Xiaoyue Chen, currently pursuing my Master's in Financial Engineering at the University of Illinois Urbana-Champaign. During my undergraduate period I start to get interested in the financial market and open my own trading account and observe the market movement every day. I decide to pursue the career as a Quantitative Researcher/Data Analyst after graduation.During my internship I did many researches about high frequency trading, especially on time series limit order book and order flow. I am familiar with the data analysis with the high frequency trading data.
-
My LinkedIn is located here: https://www.linkedin.com/in/xiaoyue-chen-93719b178/
-
My github is located here: https://github.com/chengxiaoyueqaz
Choose a self-explaining name for your project.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.