contribute.md

How To Contribute

Steps

1. First, you should fork this project. If your Github username is Mary, then you will have your own project named Mary/ACMHomepage.
2. Then, use the command git clone or something else to get the source code.
3. If you want to update README of the package front, then you need to create a new branch named update-README-of-the-package-front. A meaningful branch name will be helpful.
4. Edit, commit, rebase to get a really clear commit list.
5. Push to your own project Mary/ACMHomepage (so you can push with flag --force).
6. Create a PR from Mary/ACMHomepage to ACMHomepage/ACMHomepage. We will talk with you. The next step will be the 5th or 7th step.
7. Done.

Git Commit Message Style

Like this rule but changed something.

• 80 character each line.

• Use Markdown syntax.

• Head: <type>[scope]: <subject>.

  • <type>:
    • feat: Add a new feature.
    • fix: Fix a bug.
    • docs: Documenttation.
    • style: Just change the code's style or just fix typo.
    • refactor: Not add a new feature, neither fix a bug. Just make code clear than before.
    • test: About test.
    • chore: Updating grunt tasks etc; no production code change.
  • [scope]: Optional. Enclosed in parentheses.
    • back: For backend. In folder /back.
    • front: For frontend. In folder /front.
  • <subject>, Make sure the first character is UPPERCASE and has a space before is. End by a period(.).

• Body:

  • If you think a URL is useful to be referenced, we strongly recommend you follow the rule: > URL.

    DO NOT split URL even it will break the '80-char-per-line' rule to make sure the URL is clickable.

    Example:

    • When the url is short enough to display in one line:

      Please use the google to sreach:
      
      > www.google.com
      

    • Even the link is too long, please DO NOT split it into two or more lines:

      An apple a day keep the doctor away. An apple a day keep the doctor away.
      And please follow this link to know more:
      
      > https://stackoverflow.com/questions/52893454/does-the-comma-operator-odr-use-its-arguments
      

PR Check List

Click to know more.

To-do Tree

• Add a user entrypoint.
  • Add error message if sign in fail.
• Remove typescript's warning and error.
• Update test.
  • Add test for News.
  • Add test for Carousel.
  • And so on.
• Use deno instead of node.js.
• Remove any in .ts file.
• Add cache for picute.
• Make test runable.
• How about add sx prop in theme-ui's Global?
• Emmm... So how about let every page know the before scroll position.
• Let the ACM Homepage in Nav be a button.
• Remove warning of msw when it ask for picture.
• Now we have News component and News page. Try to remove one or something else.
• How can I use typedoc?
• Make the Nav has bigger place to touch.
• Deal with JWT + cookie + CORS.
• Work with HttpOnly cookie.
• Add e2e test.
• Update component PureSwitch with sx prop.
• Add favicon.ico.
• Use HTTPS instead of HTTP.
• Let backend use yarn than npm.
• Well, the Dockerfile and connection.js use the same password but in different files. Move the password into the makefile.