Skip to content

Latest commit

 

History

History
83 lines (47 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

83 lines (47 loc) · 3.64 KB

Contributing to Public Resources for Aerial Archaeology

Thank you for considering contributing to the Public Resources collaborative project for Aerial Archaeology! We appreciate your interest and welcome all contributions, whether it's adding new resources, improving documentation, or helping with other aspects of the project.

How to Contribute

1. Fork the Repository

Start by forking this repository to your GitHub account. This will create a copy where you can work on your contributions independently.

2. Clone the Forked Repository

Clone the forked repository to your local machine using the command:

git clone https://github.com/your-username/repo-name.git

Replace your-username with your GitHub username and repo-name with the name of this repository.

3. Create a New Branch

Create a new branch for your work. Use a descriptive name that reflects the nature of your contribution:

git checkout -b feature/add-new-resource

4. Make Your Changes

Make the necessary changes in your branch. For adding new resources, follow the structure used in the existing tables. Ensure your additions are clear, accurate, and well-documented.

5. Test Your Changes

Before submitting your changes, make sure everything works as expected. While this project may not involve executable code, it's important to double-check the formatting and links in your additions.

6. Commit Your Changes

Commit your changes with a clear and descriptive message. Use the following format:

git commit -m "Added [Resource Name] to [Category Name]"

This will help maintain clarity in the project's history.

7. Push to Your Fork

Push your changes to your forked repository:

git push origin your-branch-name

8. Submit a Pull Request

Go to the original repository and submit a pull request. Provide a clear description of your changes, and mention any relevant details, such as why you believe the resource is valuable.

9. Wait for Review

One of the project maintainers will review your pull request. They may request changes or provide feedback. Please be open to this process as it ensures the quality and consistency of the project.

Guidelines for Adding Resources

  • Accuracy: Ensure that the resource links and information you add are accurate and current.
  • Consistency: Follow the existing format for tables and descriptions. This includes the order of columns and the style of notes.
  • Relevance: Only add resources that are directly relevant to aerial archaeology, such as LiDAR data, aerial imagery, historic maps, archaeological registers, etc.

Code of Conduct

We are committed to fostering a welcoming and inclusive environment for everyone, regardless of background, identity, or experience. As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

Reporting Issues

If you encounter any issues with the project or have suggestions for improvements, please open an issue. Before reporting, check if the issue has already been discussed.

Getting Help

If you need help or have any questions about contributing, feel free to open an issue or reach out through our Facebook community.

Acknowledgments

We are grateful for all contributions, no matter how small. Your involvement helps make this project a valuable resource for the community.