Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.21 KB

contributing.md

File metadata and controls

51 lines (33 loc) · 2.21 KB

Contributing to Comp3D

Thank you for considering contributing to Pompei! This document outlines the process for contributing to our project.

Support

The Institut national de l'information géographique et forestière (IGN) develops this software. However, please be aware that our resources are limited. We appreciate your understanding and patience.

Reporting issues

If you encounter any issues, please follow these steps:

  1. check the documentation: check the documentation to see if your issue is addressed there.
  2. check for updates: ensure that you are using the latest version of the software.
  3. check existing issues: check the issue tracker to see if a similar issue has already been reported.

If the issue persists, open a new ticket in the issue tracker.

Contributing

We welcome contributions in various forms, including but not limited to:

  • testing: help us by testing the software and reporting bugs.
  • documentation: improve the existing documentation or add new sections.
  • bug fixes: submit fixes for reported issues.
  • new features: implement new features.

Please note that while we appreciate all contributions, there may be delays in reviewing and merging due to limited workforce.

How to contribute

To contribute, please follow these steps:

  1. fork the repository: create a personal fork of the repository on GitHub.
  2. clone your fork: clone your fork to your local machine.
  3. create a branch: create a new branch for your work (e.g., feature/awesome-feature or bugfix/issue-123).
  4. commit changes: commit your changes to your branch.
  5. push to GitHub: push your branch to your fork on GitHub.
  6. create a pull request: when ready, open a pull request (PR) from your branch to the main branch of the original repository.

If you make a substantial contribution to a source file, add your name to the list of authors in the file's license notice.

Pull request guidelines

  • ensure your code adheres to the project's coding standards.
  • update the documentation as necessary.
  • include tests for new features or bug fixes.
  • provide a clear and detailed description of your changes in the pull request.

Thank you for your contributions and support!