Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

66 lines (38 loc) · 3.44 KB
Raw

Contributing

Contributors are more than welcome. How can you contribute?

Report bugs

We want our app to be as stable as possible thus your bug reports are immensely valuable. File GitHub Issues for anything that is unexpectedly broken.

  • App version
  • Device model
  • Android version
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior (a screenshot and/or log file may be helpful)

Contribute Code Open Source Helpers

We have labeled tasks you can help with as GitHub issues by-label and GitHub issues by-label. Just pick up an issue that you're interested in and start coding. If you have a great idea you really want to implement, start by logging an issue for us. We'll let you know if it fits with our product direction and then you can start development. When you're ready open a Pull Request with a description of your changes.

See Git Essentials for a simple bugfix workflow.

Translate

You don't have to be a programmer if you want to translate this application in your own language or improve existing translations. You can translate SoundRecorder using POEditor - a collaborative translation platform.

POEditor

Automate Testing

Testing is imperative to the health of the project. There's a configured CI pipeline (Travis CI) intended for running unit tests and instrumented tests on every commit to the repository, but unfortunately, there're very few tests at the moment.

Please follow standard guidelines if you want to contribute a test:

  1. Android Developers - Test apps on Android
  2. Android Studio - Test your app
  3. GitHub - Android testing samples

Git Essentials

Workflows can vary, but here is a very simple workflow for contributing a bug fix:

  1. Fork the repository.

  2. Clone the fork:

    $ git clone [email protected]:YOUR_USERNAME/SoundRecorder.git
$ git remote add upstream https://github.com/naXa777/SoundRecorder.git

    Read why do you need to Configure a remote if you're interested.

  3. Prepare a feature branch:

    $ git checkout -b issue-123-keyword master

  4. Do development and then commit your changes:

    $ git commit -m "fix #123 - Description of what I had changed"
$ git push

    A quick note: See Chris Beams' guide to writing good commit messages - How to Write a Git Commit Message.

  5. Open a pull request.

    Read Creating a pull request from a fork for details.