Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 6.7 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 6.7 KB
Raw

Contributing to DiscipleTools Mobile App

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to DiscipleTools Mobile App and its associated files, which are hosted in the DiscipleTools on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

This project and everyone participating in it is governed by the DiscipleTools Mobile App Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Reporting Bugs 🐛🪲🐜

Where to Find Known Issues

We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

Reporting New Issues

The best way to get your bug fixed is to follow our Bug Report Template. This template will help to speed up the process of reproducing and resolving the bug.

Security Bugs

DiscipleTools is a non-profit and does not have a bounty program for the safe disclosure of security bugs. That said, please do not file public issues for security bugs. Please report security issues to [email protected].

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Please perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. Otherwise, please proceed to create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of DiscipleTools Mobile App which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most DiscipleTools Mobile App users.
  • List some other popular mobile applications where this enhancement exists.
  • Specify which version of DiscipleTools Mobile App you're using. You can find the exact version on either the splash screen or under the Settings Tab
  • Specify the name and version of the OS you're using.

Your First Code Contribution

Unsure where to begin contributing to DiscipleTools Mobile App? You can start by looking through these beginner and help-wanted issues:

  • Beginner - issues which should only require a few lines of code, and a test or two.
  • Help wanted - issues which should be a bit more involved than beginner issues.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

Pull Requests

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We'll do our best to provide updates and feedback throughout the process.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from development (this is IMPORTANT! Many open source projects will ask you to fork from the master branch. Please notice that we are specifying the development branch).
  2. Run yarn in the repository root.
  3. If you've fixed a bug or added code that should be tested, add tests!
  4. Ensure the test suite passes (yarn test). Tip: yarn test --watch TestName is helpful in development.
  5. If you need a debugger, run yarn debug-test --watch TestName, open chrome://inspect, and press “Inspect”.
  6. Format your code with prettier (yarn prettier).
  7. Make sure your code lints (yarn lint). Tip: yarn linc to only check changed files.
  8. If you haven’t already, please take the time to read and understand the LICENSE

Git Commit Messages

JavaScript Styleguide

All JavaScript should adhere to JavaScript Standard Style.

Semantic Versioning

DiscipleTools Mobile App follows semantic versioning (i.e., X.Y.Z). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.

License

By contributing to DiscipleTools Mobile App, you agree that your contributions will be licensed under its GNU General Public License v3.0.

Thanks! ❤️❤️❤️

DiscipleTools Mobile App Team