gazebosim / gazebosim/docs

Update the style guide to outline how namespaces should be used

Open
#225 3 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
88
Forks
319
Avg merge
2h 2m
Merged PRs (30d)
1

Description

## Desired behavior
We currently do not have any rules/guidelines on how namespaces should be used. This could result in naming collisions between various projects. We should outline dos and don'ts of namespace usage for ignition projects.

## Alternatives considered
N/A (new feature)

## Implementation suggestion
Add a section to https://ignitionrobotics.org/docs/all/contributing#style-guides that outlines how namespaces should be included/used. Some guidelines were discussed in this thread: https://github.com/ignitionrobotics/ign-sensors/pull/177#discussion_r774794118

## Additional context
The original conversation for this was started in https://github.com/ignitionrobotics/ign-sensors/pull/177#discussion_r774794118

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.