Contribution

To maintain a high-quality, organized, and inclusive TOOLS4CITIES Wiki, we recommend all contributors follow these guidelines when writing, submitting, and reviewing articles:

Pertinence and Relevance

Before writing your article, please ensure it is pertinent to this Wiki. Development documentation and tool setup instructions, for example, are better suited in README files within the relevant Gitea repository. The TOOLS4CITIES Wiki focuses on tool conceptual overviews, user guides, and architectural documentation rather than implementation details.

Audience and Context

Please consider your intended audience and their domain of expertise before writing. For example, introductory articles about our TOOLS4CITIES should ideally be accessible to a broader audience, while articles covering tool documentation or detailed use cases can assume readers have a research/technical background.

Structure and Organization

The top-level items you see in the left-side menu represent the tools in TOOLS4CITIES and other major topics of discussion in this Wiki. When creating a new article, please place it at the appropriate hierarchical level under the most relevant tool or topic. If you are unsure where something belongs, please ask other experienced contributors for guidance.

Search and Discoverability

Use clear and consistent titles to make articles easily discoverable through keyword searches. For example, introductory articles must be titled “About”. Additionally, please adhere to established naming conventions to ensure keyword consistency. For example, write “CITYlayers” not “City Layers”, and “TOOLS4CITIES” not “Tools for Cities”.

Writing Style and Quality

Please ensure your article is free of spelling and grammar issues. Please use American English spelling (e.g., “analyze” not “analyse”, “center” not “centre”), use the Oxford comma, and define acronyms precisely, unless they are widely recognized within our organization (e.g., NGCI, CERC).

The names of tools in the TOOLS4CITIES suite must always be written as follows:

  • The word “CITY” must be all uppercase and regular weight (no bold).

  • The word after “CITY” must be all lowercase and bold.

  • The word TOOLS4CITIES must be all uppercase, with the word “TOOLS” in bold.

For example, write “CITYlayers” not “CITYLayers”, “CityLayers” or “Citylayers”. However, bear in mind formatting does not work inside links in an .rst file (e.g., in the text within the backticks).

ReStructuredText Syntax

All TOOLS4CITIES Wiki articles are written in ReStructuredText (RST), a markup language similar to Markdown or LaTeX. Please ensure your article contains no syntax errors and follows the same title, table and labeling styles as other articles in this Wiki.

Confidentiality and Anonymity

The contents of this Wiki are public. Please avoid sharing any confidential project information in your articles. While you are free to mention your name and affiliation in your articles, please refrain from sharing personal details about yourself or others, such as emails or phone numbers. If you are unsure, please check with your colleagues or supervisors and obtain their consent before writing anything about them or their work.

Review and Feedback

To start contributing with the TOOLS4CITIES Wiki, follow these steps:

  1. Clone the Wiki repository in your computer.

  2. Create a new branch based on main.

  3. Commit and push your files into your branch.

  4. Finally, create a pull request (PR). A Software Team member will review it promptly with the assistance of a domain expert and contact you with any questions or suggestions.

  5. Once you address the feedback provided by the reviewers, your PR will be merged, and your changes will be published in the Wiki as soon as possible.

Attention: If you do not have a CERC Gitea account, you will not be able to complete step 4. In this case, please get in touch with a Software Team member for guidance.

Ownership and Maintenance

Every contributor is an owner and responsible for the articles they write. However, no one maintains an article alone. Everyone is welcome to create new articles, as well as review and edit existing ones. The Software Team will be in charge of reviewing and merging articles into the Wiki repository, as well as keeping the Wiki webpage updated and available.

Ethics and Conduct

Please help us make the TOOLS4CITIES Wiki an open, welcoming, and healthy environment. For more information, please refer to our Code of Conduct.