Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

81 lines (48 loc) · 3.99 KB

IFRC GO Web Application Contributing Guide

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution.

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available documentation.

Before you ask a question, it is best to search for existing issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open a discussion.
  • Open an issue.
  • Provide as much context as you can about what you're running into.

I Want To Contribute

Any individual is welcome to contribute to IFRC GO. The repository currently has two kinds of contribution personas:

  • A Contributor is any individual who creates an issue/PR, comments on an issue/PR, or contributes in some other way.
  • A Collaborator is a contributor with write access to the repository.

What should I know before I get started?

IFRC GO and Packages

The project is hosted at https://go.ifrc.org/.

The project comprises several repositories, with notable ones including:

  • go-web-app - The frontend repository for the IFRC GO project.
  • go-api - The backed repository for the IFRC GO project.

Reporting Bugs

Before Submitting a Bug Report

Ensure the issue is not a user error by reviewing the documentation. Check the existing bug reports to confirm if the issue has already been reported.

Submitting the Bug Report

  1. Open a new Issue.
  2. Provide all relevant details.

After Submitting the Issue

  • The team will categorize and attempt to reproduce the issue.
  • If reproducible, the team will work on resolving the bug.

Suggesting Enhancements

Before Submitting an Enhancement

  • Review the documentation to ensure the functionality isn't already covered.
  • Perform a search to check if the enhancement has been suggested. If so, comment on the existing issue.
  • Confirm that your suggestion aligns with the project’s scope and objectives.

How to Submit an Enhancement Suggestion

Enhancements are tracked as GitHub issues.

  • Open a new feature request or Epic ticket depending on the scale of the enhancement.
  • Provide a clear description and submit the ticket.

Becoming a Collaborator

Collaborators are key members of the IFRC GO Web Application Team, responsible for its development. Members should have expertise in modern web technologies and standards.

For detailed guidelines, refer to the Collaboration Guide.