Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 3.16 KB
Raw

Contributing

Thank you for showing interest in contributing to Quiz App. We appreciate your time and effort. Let’s work together, implement our learnings and build an awesome app.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or Slack with the Mods/Co-Mods of this repository before making a change. You can find the details of all moderators in README.md.

Please note we have a code of conduct, follow it in all your interactions. Only valid contributions will be given proper attribution which are in line with the contribution guidelines listed below

Code of Conduct

Standards

  • Welcoming and Respectful language and behavior
  • Constructive Criticism
  • Accepting Different Viewpoints and Team decision

Unacceptable Behavior:

  • Trolling, insulting/derogatory, personal comments
  • Unethical means to highlight your contribution

How to get started?

To get started, please abide by the following steps:

  1. First check out the issues board. You can join the conversation if the topic you want to discuss is already open, otherwise create a new issue. You can create a new issue according to issue template.
  2. After creating the issue, please drop a comment on the issue about you willing to work on the same & start working on it. The best and the most efficient PR will be merged to the project after the deadline provided the PR follows all the guidelines.
  3. You can fork the repo and use the development branch of the repository. Please ensure you create a branch from development branch only. This is where the latest and approved changes reside.
  4. Create a branch on your local repo specific to the issue or feature you are working on. Push your work on that branch.
  5. Branch naming convention: bugfix-xxxxx, feature-xxxxx, enhance-xxxxx, refactor-xxxxx or misc-xxxxx. xxxxx: 1-2 word description of the bug or feature or issue_id (separated by underscore “_”. E.g. feature-login_screen, refactor-notification_module etc.)
  6. Please ensure your pull request is mergeable, take pull from original repo and resolve all conflicts locally before creating a PR.
  7. After all is done on your end, you can submit a pull request from your branch to Quiz App's development branch. The PR will be reviewed and feedback will be given accordingly.

Note:

  • Only the PRs that follow our guidelines will be entertained, so make sure you read the guidelines before raising a PR.
  • For any future modifications or bugs please raise issue from the issue tab.
  • Look out for all kinds of labels, specially the High Priority Label which requires immediate action.

For complaints, queries and help, please contact us on slack at channel #cp_quiz_app.