Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.85 KB
Raw

Contributing to EzTest

🎈 Thank you for your interest in contributing to EzTest! 🎈

We welcome all contributions and hope you will do your best to follow the given guidelines in order to smooth the development process.

How to contribute

Report a bug | Suggest bug fix

Please create an issue marked with the bug label. When writing the issue please attempt to follow the issue template for bugs.

Know of a fix?

If you have a fix for the bug please create a pull requests. Make sure to fully describe the issue along with how your solution fixes the problem.

New feature

Suggest a new feature by creating an issue marked with the new feature label.

Developing a feature

If you have developed a new feature please make sure you have followed the style guides by doing a self review.
All new features should be developed in response to an issue. A common process would then be to create an issue marked with the new feature or enhancement label, develop the feature and then create a pull-request.

Development guidelines

Git commit messages

Each git commit should be accompanied by a message giving a clear indication of what has been changed. If the commit is in response to an issue, make sure to reference the issue in the commit message.

Code

  • Indentation and brackets follow Allman style
  • Indentation should be 4 spaces
  • Code documentation should follow "JavaDoc style"
    Example: 
        /**
     * 
     * @param 
     * @see 
     * @return 
     */

Integration

To smooth integration, it is recommended that you develop on a branch specific for your feature. Once you have completed the feature please create a pull-request to get the code reviewed and merged.