Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 2.46 KB

Contributing to ideamaps-models

Thank you for considering contributing to the IDEAMAPS Data Ecosystem project! We welcome contributions from the community to help improve our modelling and data related work.

How to Contribute

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue in our GitHub repository. Provide as much detail as possible to help us understand and address the issue.

Submitting Pull Requests

  1. Clone the Repository: Clone the repository to your local machine. git clone https://github.com/your-username/ideamaps-models.git
  2. Open an Issue: Discuss the changes you would like to make in an issue. This helps us understand your proposed changes and provide feedback.
  3. Create a Branch: Create a new branch for your changes. Branch names should be in the following format - <issue-number>-<issue-name>. For example: git checkout -b 123-my-feature-name
  4. Make Changes: Make your changes to the codebase.
  5. Commit Changes: Commit your changes with a descriptive commit message. git commit -m "Description of your changes"
  6. Push Changes: Push your changes to your fork.git push origin feature/your-feature-name
  7. Open a Pull Request: Open a pull request to the main repository - dev. Provide a clear description of your changes and any related issues.
  8. Request Review: After opening a pull request, request the approval of a maintainer. The maintainer will review your changes and provide feedback.

Code Style

Please follow the existing code style and conventions used in the project. Ensure your code is well-documented and includes comments where necessary.

When opening new branches for the repository - please follow the branch convention outlined below.

<issue-number>-<issue-name>
Example:
123-my-feature-name

Documentation

Update the documentation to reflect any changes or new features you have added. This includes adding or updating README files, code comments, and any other relevant documentation.

Getting Help

If you need any help or have questions, feel free to reach out by opening an issue or contacting the maintainers.

Specifically you can email either:

We appreciate your contributions and look forward to working with you! Thank you, The IDEAMAPS Data Ecosystem Team