跳转至

Contribution

为EvalCSU贡献

Contribute to EvalCSU

简体中文 繁體中文

All kinds of contributions are welcome, including but not limited to the following:

  • Correct the spelling of any documents or bugs and typos of any project
  • Add any class or test notes and mind maps, or translate existing content into other languages
  • Add your curriculum experiment project, it is best to include the report
  • Add your evaluation of curriculum experiment, courses, and teachers

Workflow

Evaluation 1. Apply to become an evaluation participant 1. Go to the Issue page, then click the New Issue button 2. Select Apply for evaluation template to create your issue 3. Assign who is responsible for the major, and send an email to notify him. then he will agree in issue if you are accepted 2. Create your pull request 1. Please provide your evaluation through a pull request. The guide is right below 2. Remember to link the issue that proves your quality of participant.

Provide curriculum experiment project and report

  1. Create a pull request， choose all of the collaborators as reviewers， then assign who is responsible for the relating major.

How to create a pull request

  1. fork and pull the latest version of this repo
  2. create a new branch to commit your changes(don't commit to master/main branch)
  3. commit your changes
  4. to the pull requests page, click the "new pull request"
  5. Select the master/main branch and the branch you have changed for comparing， then describe your work as right below
  6. The title format is type: --timeStamp description
  7. write a summary of your work in the context
  8. write what you have done in detail right below a "Done" title
  9. here is the example
  10. Click "Create pull request"

Please describe your issue or PR as clear as possible. And use NULL to fill blocks you don't know what to say instead of deleting them.

WANT TO KNOW WHAT IS "PULL REQUEST" AND "ISSUE"

please refer to noob guide

EvalCSU commit message

Please follow the commit formate:

<type>[optional scope]: <descroption>

type of commit

type Describtion
feat add a new feature
fix fix bugs
docs update documents
test add or update tests
style format style of codes
chore other commits