Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

63 lines (52 loc) · 3.23 KB
Raw

Contibuting to GitHubSearchMadeEasy

Welcome contributors to the project:

Short Links to Important Resources:

  • bugs: issue tracker / bug report tool

Roadmap:

  • Make the interface more informative
  • Allow users to fork from this tool itself
  • Add a forum to allow beginners to find potential mentors and help

Development environment details

You will need R installed on your system. Check README for more details.

How to submit changes: Pull Request protocol etc.

To submit a contribution:

  1. Fork the repository.
  2. Clone the original repository to your local PC
  3. Add your fork with git@github.com:username/HackIllinois2018_RAD.git
  4. If you already have a fork and copy of the repo, you can simply check to make sure you're up-to-date
      Pull the upstream:git pull upstream --rebase
      Update the submodules:git submodule update --recursive --init
  5. Create a separate branch (recommended if you're making multiple changes simultaneously)
      (git checkout -b my-branch)
  6. Make changes
  7. . Commit (git add ; git commit) and write your commit message
  8. Pull from upstream (git pull upstream --rebase) (Note: Make sure to include --rebase, as it will apply your changes on top of the changes you just pulled, allowing for a much cleaner merge)
  9. Push to your fork (git push origin _branch_), _branch_ being the branch you created earlier
  10. Create a pull request
  11. Describe changes
  12. Submit!

How to report a bug:

  • Templates: *If you find a bug, you can also file an issue. Please provide as much relevant information as you can, and include a minimal reproducible example if possible. Add label "bug-report"
  • First bugs for Contributors *Look for issues tagged with the label "good first issue" or "beginner". Feel free to play with the app and find any bugs(just do not compromise the server).

New Feature Requirements

  • Open requests for new features as an issue, and add the label "enhancement-request"

Style Guide / Coding conventions

Remember to do a git rebase -i upstream/master before you send your patch! Make sure your code is readable, commented, and well-documented. Follo they Google R style guide

Code of Conduct

Please be courtous. While we tru to merge pull requests after verificatio, this may take some time. Be patient. Do no post vulgar/obscene comments either in issues, in commits or anywhere in this project, including the code.

Recognition model

Contributers will be added to the Contributers file

Where can I ask for help?

Don't hesitate to ask for help, comments or suggestions! Before implementing something, discuss it! Open an issue.