Skip to content

Pull Request Policy

Joe Gorman edited this page Jan 8, 2014 · 5 revisions

The Figaro team is concerned that the interests of Figaro users and contributors be respected now and in the future. The Figaro team wants to encourage contributions that enhance the Figaro Programming Language and ensure that this implementation of Figaro is based on sound mathematical theory and engineering principles. As a result, the Figaro team has adopted the following policies for processing pull request that should ensure the orderly development of Figaro.

  1. Contributors must complete and submit a Contributor Agreement before any pull requests will be processed. Please email completed forms to P2T2@cra.com. You will be contacted when the agreement has been processed.

  2. All pull requests will be atomic (i.e., committed or rolled back as a unit). Each pull request should ideally apply to one feature, correction, or enhancement that must be documented in the Issues list. The pull request will document the issue number(s) resolved.

  3. All pull requests apply to the current development branch that is documented in the README.md file on the Figaro project home page.

  4. Pull requests include:

       a) All new and updated files, resources, and directories
    
       b) No build artifacts (i.e., generated class files, JAR files, directories, etc.)
    
       c) The specific issue number that the submission addresses
    
       d) Documenting comments that describe the approach in appropriate detail
    
       e) Sufficient unit tests to reproduce the issue and show that the issue was properly addressed.