Contributing to Inpenso

First off, thank you for considering contributing to Inpenso! It's people like you that make Inpenso such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Code of Conduct

This project and everyone participating in it is governed by the Inpenso Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [dmindrescu03@gmail.com].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Inpenso. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report:

• Check the debugging guide for tips — you might be able to find the cause of the problem and fix things yourself.
• Check if you can reproduce the problem in the latest version of Inpenso.
• Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A Bug Report? Bugs are tracked as GitHub issues. Create an issue and provide the following information:

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible.
• Provide specific examples to demonstrate the steps.
• Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
• Explain which behavior you expected to see instead and why.
• Include screenshots if possible.
• Include details about your configuration: iOS version, device model, etc.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Inpenso, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion:

• Check if you're using the latest version of Inpenso.
• Perform a 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.

How Do I Submit An Enhancement Suggestion? Enhancement suggestions are tracked as GitHub issues. Create an issue 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.
• Provide specific examples to demonstrate the steps or point out the part of Inpenso which the suggestion relates to.
• Describe the current behavior and explain which behavior you expected to see instead and why.
• Include screenshots or screen recordings which help you demonstrate the steps or point out the part of Inpenso which the suggestion relates to.
• Explain why this enhancement would be useful to most Inpenso users.

Pull Requests

• Fill in the required template
• Do not include issue numbers in the PR title
• Include screenshots and animated GIFs in your pull request whenever possible
• Follow the Swift style guide
• Include tests if applicable
• Document new code based on the rest of the codebase
• End all files with a newline

Styleguides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line
• Consider starting the commit message with an applicable emoji:
  • 🎨 :art: when improving the format/structure of the code
  • 🐎 :racehorse: when improving performance
  • 🚱 :non-potable_water: when plugging memory leaks
  • 📝 :memo: when writing docs
  • 🐛 :bug: when fixing a bug
  • 🔥 :fire: when removing code or files
  • ✅ :white_check_mark: when adding tests
  • 🔒 :lock: when dealing with security
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :arrow_down: when downgrading dependencies

Swift Styleguide

All Swift code should adhere to the Swift API Design Guidelines, Swift Style Guide, and the style of the existing codebase.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

• bug - Issues that are bugs
• documentation - Issues or PRs related to documentation
• enhancement - Issues or PRs that are improvements
• good-first-issue - Good for newcomers
• help-wanted - We need help with this!
• wip - Work in progress

Thank you for contributing to Inpenso!