github.com/ScaleFT/monotime@v0.0.0-20180209174256-2da272f3dad0/CONTRIBUTING.md (about)

     1  # How to Contribute
     2  
     3  ScaleFT's projects are [Apache 2.0 licensed](LICENSE) and accept contributions
     4  via GitHub pull requests. This document outlines some of the conventions on
     5  development workflow, contact points, community conduct and other resources
     6  to make it easier to get your contribution accepted.
     7  
     8  # Code of Conduct
     9  
    10  This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
    11  By participating, you are expected to uphold this code.
    12  
    13  Please report unacceptable behavior to [opensource@scaleft.com](mailto:opensource@scaleft.com).
    14  
    15  # Reporting Security Issues
    16  
    17  ScaleFT takes security seriously. If you discover a security issue, 
    18  please bring it to our attention right away!
    19  
    20  Please DO NOT file a public issue or pull request,
    21  [instead send your report privately to the ScaleFT Security Team](https://www.scaleft.com/company/security/),
    22  reachable at [security@scaleft.com](mailto:security@scaleft.com).
    23  
    24  Security reports are greatly appreciated and we will publicly thank you for them.
    25  
    26  # Getting Started
    27  
    28  - Fork the repository on GitHub
    29  - Read the [README](README.md) for build and test instructions
    30  - Play with the project, submit bugs, submit patches!
    31  
    32  # Contribution Flow
    33  
    34  This is a rough outline of what a contributor's workflow looks like:
    35  
    36  - Create a topic branch from where you want to base your work (usually master).
    37  - Make commits of logical units, rebasing later is ok too!
    38  - Push your changes to a topic branch in your fork of the repository.
    39  - Make sure the tests pass, and add any new tests as appropriate.
    40  - Submit a pull request to the original repository.
    41  
    42  Thanks for your contributions!