- 
                Notifications
    
You must be signed in to change notification settings  - Fork 2.8k
 
Add attributes-meta document #1331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
      
            heiglandreas
  wants to merge
  5
  commits into
  php-fig:master
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
heiglandreas:add-addtributes
  
      
      
   
  
    
  
  
  
 
  
      
    base: master
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
  
     Open
                    Changes from 1 commit
      Commits
    
    
            Show all changes
          
          
            5 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      579e040
              
                Add attributes-meta document
              
              
                heiglandreas 477daa1
              
                Apply suggestions from code review
              
              
                heiglandreas 6c9b589
              
                Set editor and sponsor
              
              
                heiglandreas fd4e239
              
                Update proposed/attributes-meta.md
              
              
                heiglandreas 0d2e30a
              
                Thanks @jaapio
              
              
                heiglandreas File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # Attributes Meta Document | ||
| 
     | 
||
| ## 1. Summary | ||
| 
     | 
||
| The idea is to create a registry that holds and provides user-space attributes for PHP. | ||
| 
     | 
||
| This Proposal is about defining the registry and the workflows to add, modify and | ||
| remove attributes from that registry | ||
| 
     | 
||
| ## 2. Why Bother? | ||
| 
     | 
||
| Right now libraries that want to use attributes either have to define them themselves or rely upon | ||
| another library that has them defined. Most of the time that also means to import all the code of | ||
| the other library. | ||
| 
     | 
||
| Userland libraries have no interest in provising an interoperable set of attributes as they solve | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
          
            Show resolved
            Hide resolved
         | 
||
| a specific problem with *their* set of attributes. | ||
| 
     | 
||
| This registry shall solve that | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| ## 3. Scope | ||
| 
     | 
||
| ### 3.1 Goals | ||
| 
     | 
||
| * Define and maintain a set of attributes that are relevant for more than one | ||
| single tool so that different tools can use and rely upon a defined set of attributes and | ||
| users do not need to use several similar attributes with the same meaning for different tools. | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| * Provide one or multiple composer-installable packages containing | ||
| the code for the attributes in the registry | ||
| * provide methods to maintain the registry and add, modify and remove attributes from it | ||
| 
     | 
||
| ### 3.2 Non-Goals | ||
| 
     | 
||
| * The goal is **not** to provide a registry of **all** attributes available in PHP. As an example: The ORM-specific | ||
| attributes from Doctrine are likely not to be part of this registry as they are specific to the library itself | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| ## 4. Approaches | ||
| 
     | 
||
| TBD | ||
| 
     | 
||
| 
     | 
||
| ## 5. People | ||
| 
     | 
||
| ### 5.1 Editor | ||
| 
     | 
||
| * TBD | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| 
     | 
||
| ### 5.2 Sponsor | ||
| 
     | 
||
| * TBD | ||
| 
     | 
||
| ### 5.3 Working group members | ||
| 
     | 
||
| * Juliette Reinders-Folmer | ||
| * Jaap vsn Otterdijk | ||
                
      
                  heiglandreas marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||
| * Vincent de Lau | ||
| * Larry Garfield | ||
| * Andreas Heigl | ||
| 
     | 
||
| ## 6. Votes | ||
| 
     | 
||
| * [Entrance Vote](https://groups.google.com/g/php-fig/) | ||
| * [Acceptance Vote](https://groups.google.com/g/php-fig/) | ||
| 
     | 
||
| ## 7. Relevant Links | ||
| 
     | 
||
| 
     | 
||
| ## 8. Past contributors | ||
| 
     | 
||
| This document stems from the work of many people in previous years, we recognize their effort: | ||
| 
     | 
||
| * | ||
| _**Note:** Order descending chronologically._ | ||
| 
     | 
||
| ## 9. FAQ | ||
| 
     | 
||
| TBD | ||
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.