Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 3.14 KB
Raw

I4G-OPENSOURCE-BACKEND-PROJECT-2022

Contributing to the project

Please make sure to read the relevant section before making your contributions, it will make it a lot easier for maintainers to make the most of it and smooth out the experience for everyone involved. 🚀

Table of Contents

Introduction

HacktoberFest is back again!. Much appreciation for your desire to participate in the I4G OpenSource Backend project. See the table of content for different ways to help and details about how this project handles them!📝

Intended audience

  • Project contributors
  • Backend developers
  • Issue reporters
  • Improvement reporters

How to contribute

  • You need a GitHub account
  • You need a local "fork" of this Github repo.
  • Clone the repository to your local machine.
  • Submit an issue ticket if there is none yet.

Working with Issues

Click issues in the repository to see the reported issues.

Submitting an Issue

  • Describe the issue and include steps to reproduce it if it is a bug.
  • If you are able and want to fix this, fork the repository on GitHub
  • See Issue Template for a formatted way of submmiting an issue.

Submit Changes

  • Please avoid working directly on the exisiting branches.
  • In your forked repository, create a branch for your upcoming patch. (e.g. feature--autoplay or bugfix--ios-crash)
  • Make sure you stick to the coding style that is used already.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Assure nothing is broken by running all the tests.
  • Push your changes to the your branch in your forked repository.
  • Open a pull request to the original repository and choose the right original branch you want to patch.
  • If not done in commit messages (which you really should do) please make reference and update your issue with the code changes. But please do not close the issue yourself.
  • Do NOT commit to other contributor's codebase/issue without their consent.
  • You can modify previous solutions if you feel like your solution has better Time or Space complexity.
  • Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.

Code of conduct

Communication

Licensing

The I4G Backend 2022 project is an open source and under public licensing. Let's all Contribute!😃