contributing-to-openg2p.md

description
Contributing to OpenG2P

Contributing

OpenG2P is a collaborative effort of several contributors. We welcome contributions to the OpenG2P Project.

Issues

Raise bugs/issues/tasks on GitHub Issues of individual repositories.

All the issues and tasks are tracked using Jira.

Discussions

Join our community for keeping track of key announcements, and updates and discuss any matters related to the project with the larger community. You may post your technical questions on the platform here.

Code contributions

To contribute code to the OpenG2P project, follow the steps given below:

1. Create an issue on Github related to your task.
2. Fork the corresponding repository.
3. Commit your changes in your forked repo. Make sure the issue id of GitHub is mentioned in square braces, e.g. [#6] Minor changes to fix the bug.
4. Raise a Pull Request (PR) on the appropriate branch. In general, it is safe to send PRs to develop branch of a repo.
5. The PRs shall be reviewed by the technical team and merged after approval.

Coding conventions

• For Odoo modules, follow the Odoo Coding Guidelines.
• For non-Odoo Python code, follow PEP 8 – Style Guide for Python Code.

Documentation contributions

The documentation of the project is available as .md files in the Documentation repository. To highlight a correction or request for additional documentation, raise a GitHub Issue on the repository. To contribute to the documentation follow the steps given under Code contributions.

Versioning of modules

Refer to the Versioning guide.