Skip to content
This repository has been archived by the owner on May 30, 2022. It is now read-only.

Latest commit

 

History

History
31 lines (29 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

31 lines (29 loc) · 2.3 KB
Raw

Contributing

First off, thank you for considering contributing to Open Pics. It's people like you that will make Open Pics a great app.

How can you contribute?

We love to receive contributions from our community — you! There are many ways to contribute, from sharing the app, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into OpenPics itself.

  • Report bugs Report bugs at https://github.com/lohanitech/openpics/issues If you are reporting a bug, please include:
    • Your operating system name and version.
    • Any details about your local setup that might be helpful in troubleshooting.
    • If you can, provide detailed steps to reproduce the bug.
    • If you don't have steps to reproduce the bug, just note your observations in as much detail as you can. Questions to start a discussion about the issue are welcome.
  • Fix Bugs Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
  • Implement Features Look through the GitHub issues for features. Anything tagged with "enhancement" and "please-help" is open to whoever wants to implement it. Please do not combine multiple feature enhancements into a single pull request.
  • Writing tests This is a electron project with frontend in Angular 2 project using Angular CLI. So writin tests for Angular 2 project. Read more at https://angular.io/docs/ts/latest/guide/testing.html
  • Writing documentation Write new documentations and improving all for developers to make it a better project Write documentations here: https://github.com/lohanitech/openpics/wiki
  • Submit feedback The best way to send feedback is to file an issue at https://github.com/lohanitech/openpics/issues

Responsibilities

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.