shanezth / j-sport-mobile-app

Hi there, I'm Shane Zhu

Welcome to my page    

• I graduated from Northeastern University(SV) with a Master's degree in Computer Science

🧭 More about Me:

• 💻 I’m currently working on personal projects;
• 🌱 Currently learning:
  • 🧮 Algorithms on LeetCode
  • 🔌 Java SpringBoot with a full-stack project
  • 💡 Data Visualization (D3, Vega-lite, and Tableau)
  • 💾 Linux Operating System as well as Tmux and Vim
  • ⚖️ US Stocks and Cryptocurrency trading
• 🔭 Hobby: Photography, Astronomy, and Cycling
• 😄 Pronouns: He/Him

📈 My GitHub Stats:

 

j-sport-mobile-app's Issues

Suggestion on Pull Request details

Hello all,

It is a good practice to have at least one other collaborator approve(review) for this pull request. It is good to avoid potential bugs and also help other collaborators to learn about what you have changed in this group of commits. Moreover, since we want others to look at the pull request, it is also important to have some sort of formatted description of what changes have been made in this PR, like the one below

---

EXAMPLE

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

• Firmware version:
• Hardware:
• Toolchain:
• SDK:

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

---

Source: https://embeddedartistry.com/blog/2017/08/04/a-github-pull-request-template-for-your-projects/
I will attach the markdown in the comment below, and not all sections in the PR description are needed in an actual PR, the key is to make the PR as clear as possible so others have a chance to know what you have done before reading your code.

Suggestion on improving collaboration procedures

I suggest using some sort of commit message formatting so when we want to use the commit messages as a reference in the future, it is easier to know what changes we have made in each commit.

Resource:

1. Semantic Commit Messages Example
2. A more detailed doc