Skip to content

Latest commit

 

History

History
141 lines (100 loc) · 6.37 KB

CONTRIBUTING.md

File metadata and controls

141 lines (100 loc) · 6.37 KB

GitHub custom open for collaboration

Contribution Guidelines

Thank You for taking time and showing interest to contribute!
The following is a set of guidelines for contributing to this project. Feel free to propose changes to this document in a pull request.

Table Of Contents

Code Of Conduct
How Can I Contribute?

⭐Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to team@tesseractcoding.tech.

⭐How Can I Contribute?

Those who are already familiar with Git can read below guidelines and start working :

  • Take a look at the Existing Issues or create your own Issues!
  • Preferably, you cannot work on any issue that is not assigned to you. Wait for the Issue to be assigned to you after which you can start working on it.
  • Fork the Repo and create a Branch for any Issue that you are working upon.
  • Make your changes.
  • Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.

Those who are contributing for the first time please follow the steps mentioned below to get familiar with the contribution processes.

  • Issues can be submitted by anyone - seasoned developers or newbies.

If you don't have git on your machine, install it.

⭐Reporting Bugs

When you are creating a bug report, please include as many details as possible since it helps in resolving the issues faster.

  • Give sample code if you can.
  • What you expected would happen.
  • What actually happened.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

⭐Suggesting New Enhancements

Submitting an enhancement suggestion , includes completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion :
  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Include screenshots and animated GIFs which can help you to describe effectively.

⭐Local Setup :

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository. Open terminal and type:

git clone https://github.com/<your-github-username>/datascience-mashup

3. Navigate to the project directory.

cd datascience-mashup

Working on an issue 👨‍💻👩‍💻

After you set up on your local machine, you can choose any of the issues from Issue tracker of the repo to work on.

For working on an issue:

1. Create a new branch from master branch

git checkout master
git checkout -b "your_branch_name>

Try to give a meaningful branch name.

2. After creating the branch, make the changes required to fix the issue.

Create a PR 🚀

After you are done with all the changes and have tested it, follow these steps for creating a PR:

1. Add the changes to the staging using

  git add .

2. Commit the changes using :

  git commit -a -m "<your_commit_msg>"

Please make sure to give a meaningful commit message.

Push changes to GitHub

Push your changes using the command git push:

  git push origin <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier.

Submit your changes for review

  • If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
  • Also make sure you don't have any merge conflicts while opening a PR.
  • Then add a title and description to your pull request that explains your precious effort.
  • Don't forget to mention the issue number you are working on.
  • Now submit the pull request.

Soon Your changes will be merged into the master branch of this project. You will get a notification email once the changes have been merged.

⭐License

By contributing, you agree that your contributions will be licensed under its MIT License.

⭐Helpful Resources

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

⭐Thank you for your contribution. ⭐

License: MIT Open Source Love

Contributors 🌟

Thanks goes to these wonderful people ✨✨: