Skip to content

Latest commit

 

History

History
111 lines (91 loc) · 6.1 KB

CONTRIBUTING.md

File metadata and controls

111 lines (91 loc) · 6.1 KB
Raw

Contributing SOSC

If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social interaction on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

Want to contribute but new to Git and Github?

How to make a clean Pull Request

  • Create a personal fork of the project on Github.

  • Clone the fork on your local machine. Your remote repo on Github is called origin.

  • Add the original repository as a remote called upstream. Read more about setting up the upstream remotes.

  • If you created your fork a while ago be sure to pull upstream changes into your local repository. Read more about keeping your fork in sync with remotes.

  • Create a new branch to work on! Branch from e.g:15CSL76 if it exists or any other valid subject_code, else from master.

  • Implement/fix your feature, comment your code in the valid directory with valid extensions. Make sure the subject_code+full_subject_name folder name is in all CAPS. e.g: 15CSL76_MACHINE_LEARNING_LABORATORY

  • Follow the code style of the project, including indentation. Add or change the documentation as needed.

  • Make sure you have strictly followed the directory structure mentioned below. The folder structure is arranged according to semester/branch/subject_code+subject_name/file_name

    .
├── sem-7
│   ├── computer_science
│   │   ├── 15CSL76_MACHINE_LEARNING_LABORATORY
│   │   │   ├── 01. Find-S Algorithm.ipynb
│   │   │   ├── 01. Find-S Algorithm.py
.   .   .   .
.   .   .   .

    If the Lab experiments contain more than one file, create a separate sub directory for each experiment. eg /semester/branch/subject_code_subject_name/experiment_no_experiment_name/filename

    .
├── sem-7
│   ├── computer_science
│   │   ├── 15CSL77_WEB_PROGRAMMING_LABORATORY
│   │   │   ├── 01 Calculator
│   │   │   |   ├── index.html
│   │   │   |   ├── style.css
.   .   .   .   .
.   .   .   .   .

  • Squash your commits into a single commit with git's interactive rebase. Create a new branch if necessary.

  • Push your branch to your fork on Github, the remote origin.

  • From your fork open a pull request in the correct branch. Target the project's subject_code branch if there is one, else go for master!

  • If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.

  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4