Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

82 lines (55 loc) · 3.14 KB
Raw

Contributing instructions

Thank you for considering to contribute to this repository! Here you will find instructions and guidelines for contributing efficiently.

Before proceeding further, please review our Code of Conduct.

Issues

If you find an issue in the Schema.got.it website or in this repository, please check if it's already known by searching the issue section, otherwise file a new one: we really appreciate it! 🚀.

You're welcome to contribute to open issues with more information or by adding :+1: on them: it will help the maintainers identify the issues to be prioritized.

Creating a new issue

There are three templates for new issues: Bug report, Feature request and General issue, pick the relevant one and follow the instructions in that template.

If you pick General issue please provide a good amount of detail in order to let other people clearly understand the issue. After the creation of the issue, the maintainers team will promptly triage it by assigning the proper labels.

Pull Requests

After opening an issue, you may want to further contribute. That's great and always appreciated! 😎

ℹ️ Please ensure that there is a pertinent issue related to what you are proposing and also make sure that someone has already reviewed it before proceeding

  1. Fork the project

  2. Follow our conventions regarding commits for your commit message

  3. Open a Pull request against master. Blank PRs have a template you can follow where you can tick a checklist. When each one of the step is done, please insert an x in between the [ ] to mark it as ready.

ℹ️ Please make sure that all the relevant tests have been run and the CI processes triggered by the commits in the PR are passing without failures. If this is not the case, the PR will not be reviewed so you have to fix them before requesting help

The CI builds a live preview of your PR that allows you to see the results of your work: please check it carefully and, if you spot any problem, uncheck the "Ready for review" box or mark the PR as Draft.

Commit messages

The commit message should be simple and self-explanatory.

We follow the Conventional Commits format and the general rules of great commit messages (read this!)

If a commit fixes an issue, please reference it in the commit body with Fix: #ISSUENUMBER.

Gitflow

This repository adopts a simplified branch management system as follows:

  • master is stable and gets deployed automatically. Never push directly to it;
  • feature or fix branches are derived directly from master.

Releases

TBA :)

Community

Want to get more involved in the community? Go to https://developers.italia.it/en/get-involved!