How to Contribute
There are many ways to contribute to the project: reporting bugs/Issues, submitting pull requests, and creating suggestions.
If you'd like to contribute to the codebase, check out the list of issues and fork the repository to address an issue (see below for instructions on getting the project running). Continue reading for detailed instructions on this.
Best way to understand how EV Map works or to debug an issue, you'll want to get the source code, run it, and make modifications.
details about run the project refer to ReadMe and githubGuide
First, fork the CSUF-ACM/electric-vehicle-map repository. You can fork using this link.
running the command:
git clone https://github.com/CSUF-ACM/electric-vehicle-map.git
git remote add upstream https://github.com/CSUF-ACM/electric-vehicle-map.git
Configure your git repository to have access to the official repository by running:
In this command we created an alias, named 'upstream', to the official repository.
If you ever need to sync your forked repository with the official repository, run the commands:
-
git fetch upstream(checks to see if anything from the official repository has changed) -
git merge upstream/master(merges those changes, if any)
You are now set to make changes to the codebase. If you plan on contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.
Once you have applied changes locally, you'll have to push your changes to your fork and submit a pull request for a code review. Mention the issue number and link it when creating a pull request.
1. To push your changes to your fork, first you'll have to ensure you have you changes committed locally.
- You can do this by first staging the file(s) you made changes using the command
git add <FILE_NAME>. - Next you'll want to commit your staged changes. Do this by running the command
git commit -m "replace this with a brief description of the changes that were made". - Finally, you can push (sync) your local changes with your remote fork by running
git push origin master.
2. Once you have your local changes synced up with your remote fork, now you have to submit a pull request.
You can submit a pull request by navigating to your forked repository on your browser and clicking the Pull request button
You then are greeted with a page that allows you to create the pull request. Ensure that the base repository is electric-vehicle-map and its base branch is master,you can setup your experiment branch to develop your own code before merging into master branch. you can use git branch to check which branch are you working on (annotated with *).
Additionally, ensure that the head repository is your fork and the compare is the branch you made changes on.
Once you are done, click Create pull request and fill the description box with any necessary information.
3. Now that you're pull request is open, we'll review it, apply any changes if needed, and merge it to master
You can track progress of you pull request any time by visiting EV Map's Pull Request section