Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

108 lines (70 loc) · 4.13 KB
Raw

Guidelines to Contribute:

👍🎉 First of all, thanks for taking the time to contribute! 🎉👍

To start contributing, kindly follow the below guidelines:

1. Fork this repository

1

2. Clone your forked copy of the project:

2

Open the terminal and run the following command:

git clone https://github.com/<your_user_name_here>/Data4ALL.git

3. Create a new branch with:

git checkout -b <your_branch_name_here>

4. Make your desired changes.

5. Add your changes with: 

git add .

6. Commit your changes with a message indicating the change you made.

For example : "add new dataset" 
git commit -m "your message"

7. Push to the origin branch: 

git push -u origin <branch-name>

8. Create a pull request

To create a pull request, click on `compare and pull requests` .Please ensure that you compare your feature branch to the desired branch of the repo you are supposed to make a PR to.

3

9. Add the title

Add an appropriate title and description to your pull request explaining your changes and efforts done.

10. Click on `Create Pull Request`.

4

11. Congrats! You made it!!

You have made a PR to the Data4ALL repository. Sit back patiently and relax while the project maintainers review your PR. Please understand at times the duration can vary from a few hours to a few days.




Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings



What to contribute?

You can add your own dataset in dataset/ path and don't forget to update the indexd.html as well. Try to test the project whether its working or not and then make a PR. You can also update README.md and CONTRIBUTING.md if required.



PR Review

Your PR will get reviewed soon by the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If everything looks good, your PR will be merged. That's it! Thank you for your contribution! Feel free to suggest any changes to this documentation.



Note

Contribution can be very small, that does not matter. We even love to receive a typo fix PR. Adding a feature or fixing a bug is not the only way to contribute. You can send us a PR for adding documentation, fixing typos or adding tests.