Skip to content

ZICONNECT Contribution Guidelines

Thank you for your interest in contributing to a UNICEF project! UNICEF believes in new approaches, partnerships, and technologies that support realizing children's rights are critical to improving their lives.

About the community

We are currently building an intelligence platform that uses data-sets inputs (connectivity, social, economic and employability) to predict social impacts in a region due to connectivity investments. We believe connectivity leverages access to new opportunities and better education that impacts people’s futures. on a project that addresses hate speech by providing victims and observers micro-interventions that help them choose strategic silence and counter narratives to combat perpetrators in a healthy and productive way.

We will also offer techniques to provide instant relief to people that have been attacked to help them overcome this challenging situation and prevent mental wellbeing issues.

And we will create a Chat Story or Chat Game to raise awareness about the growth of Hate Speech and all the possibilities we have as a community to stop this trend from scaling by changing our attitude and online behavior.

Contribute what?

There are different ways to contribute to a project. Some ways to contribute are:

  • Writing code
  • Submitting bug reports / feature requests
  • Improving documentation
  • Writing tutorials / blog posts

Contributors Guidelines

We are driving the Open Content Community to work with 3 types of tools to support the platform with the co-creations and contributions in an effective and organized way:

  • GitHub: for the official repository. Access the link here
  • GitHub Issues: for the collaboration and content analysis. Access the link here
  • Movidesk: for general subjects or requests about the platform. Contact Us, a service ticket will be generated automatically after sending the email.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Collect information about the bug.
  • Stack trace.
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM).
  • Browser version
  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to support@jobzi.com

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps.
  • If the team is able to reproduce the issue, it will be marked Bug, and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • 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.
  • Find out whether your idea fits with the scope and aims of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • 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. At this point you can also tell which alternatives do not work for you.
  • Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Opening a pull request

You should usually open a pull request in the following situations:

  • Submit trivial fixes (for example, a typo, a broken link or an obvious error).
  • Start work on a contribution that was already asked for, or that you've already discussed, in an issue

Here's how to submit a pull request

  • Fork the repository and clone it locally. Connect your local to the original “upstream” repository by adding it as a remote. Pull in changes from “upstream” often so that you stay up to date so that when you submit your pull request, merge conflicts will be less likely. (See more detailed instructions here.)
  • Create a branch for your edits. Make sure the branch name has this structure: -, for example: 1-update-contributing-md
  • Reference any relevant issues or supporting documentation in your PR (for example, “Closes #1.”)
  • Include screenshots of the before and after if your changes include differences in HTML/CSS. Drag and drop the images into the body of your pull request.
  • Test your changes! Run your changes against any existing tests if they exist and create new ones when needed. Make sure your changes don't break the project.
  • After you submit your pull request, verify that all status checks are passing.

What if the status checks are failing?

If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.