Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #161

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Welcome to the OpenAerialMap repository, and thank you for considering to contribute to our project!

OpenAerialMap is a community-driven project that aims to provide free and open access to high-quality aerial imagery for humanitarian and development purposes. Every contribution, big or small, can make a difference in achieving this goal.

Before you start, please take a moment to review our Code of Conduct, which outlines our expectations for respectful and inclusive behavior within the community.

### Reporting Issues

If you encounter any issues or bugs while using OpenAerialMap, please check our [GitHub issue tracker](https://github.com/hotosm/OpenAerialMap/issues) to see if a similar issue has already been reported. If not, please feel free to create a new issue. Please provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

When reporting an issue, please ensure that it is directed to the relevant sub-repository as OpenAerialMap has several (sub-repositories)[https://github.com/hotosm/OpenAerialMap#repositories] that serve different purposes.

### Contributing Code

Here are the steps to contribute to the OpenAerialMap:

#### 1. Fork the repository

Fork creates a copy of the repository in your own GitHub account.
Go to the [OpenAerialMap repository](https://github.com/hotosm/OpenAerialMap) and click the "Fork" button in the top right corner of the page.


#### 2. Clone the forked repository

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


`git clone https://github.com/<your-username>/OpenAerialMap.git`


Make sure to replace <your-username> with your GitHub username.


#### 3. Create a new branch

Create a new branch for your changes using the following command:


`git checkout -b branch-name`


Make sure to give your branch a descriptive name that reflects the changes you'll be making.


#### 4. Make changes

Make your changes to the codebase.


#### 5. Commit and push

Once you've made and tested your changes, commit them to your local branch using the following command:


`git commit -m "Add feature"`


Make sure to write a descriptive commit message that explains the changes you've made. Then, push your changes to your forked repository using the following command:


`git push origin branch-name`


#### 6. Submit a pull request
Go to your forked repository on GitHub and click the "New pull request" button. Select the branch that contains your changes, then click "Create pull request". This will open a new pull request in the OpenAerialMap repository, where you can describe your changes and request that they be merged into the main codebase.

That's it! You've now contributed to the OpenAerialMap.