Skip to content

How To Start A Pull Request

Guannan Ma edited this page Sep 21, 2018 · 2 revisions

1. Get familiar with rules

  • Pep8 code style check should be passed
  • Function docstring should be allied with sphinx formats
      def lock(self, msg, blocking=True):                                                                     
          """                                                                                            
          lock the file 
                                                                              
          :param msg:
              Msg that will be logged.                                                                                            
          :param blocking:                                                                            
              If blocking is True, will block there until cup gets the lock.                          
              True by default.                                                                        
                                                                                                      
          :return:                                                                                    
              return False if locking fails                                                           
                                                                                                                                                                             
          :raise Exception:                                                                              
              raise cup.err.LockFileError if blocking is False and                                       
              the lock action failed                                                                     
          """                                                                                            
          flags = 0x1               

2. Write your code

3. Start a pull

  • Commit the code changes
  • Start a pull
Clone this wiki locally