Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 2.91 KB

File metadata and controls

53 lines (29 loc) · 2.91 KB

Contributing to APOEZA.org Backend

Thank you for considering contributing to APOEZ.org Backend.

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.

As for everything else in the project, the contributions to PhotoBot are governed by our Code of Conduct.

Where do I go from here?

If you've noticed a bug or have a feature request, make one! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.

Fork & create a branch

If this is something you think you can fix, then fork main and create a branch with a descriptive name.

A good branch name would be (where issue #123 is the ticket you're working on):

git switch -c 123-add-japanese-translations

Working with open source projects

Here are a couple of friendly tutorials you can include: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Getting started

Whenever you are doing anything related to PhotoBot be sure to follow the Code of Conduct

For contributing to the code feel free to check out issues. When creating a pull request please rebase before merging so that changes are linear in the history.

How to report a bug

If you find a security vulnerability, do NOT open an issue. Please contact the organization owners https://discord.gg/V9MJdBBXpF.

To report a bug please use the bug report issues template. The template has all the questions and information we need from you to help solve this bug.

How to suggest a feature or enhancement

To create a feature or enhancement request please use the feature request issues template.

Code review process

Current project members can and will review your changes, there is a pull request template that helps outline what we would live from pull requests and changes being proposed.

Code, commit message and labeling conventions

Follow normal guidelines for git commits, limiting the length and adding extra details in the comment part of the commit. Please make commits descriptive of the change.

For Pull Requests please include an issue number or details on what is changed in the pull request.

Please comment code at least every 10 lines to explain what code does. Use more for more complicated sections of code.