Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

61 lines (47 loc) · 2.52 KB
Raw

Welcome to the ERC MATLAB Library contributing guide

Thank you for investing your time in contributing to the ERC MATLAB Library!

This guide will give you an overview of the contributing process and how to get started.

Getting started

We accept contributions in code as well as documentation. You are free to write your own scripts or improve/document scripts already present.

Contribution ideas

Create you own scripts

You are free to add scripts you feel are useful. As long as it is general purpose and reusable your contribution will be accepted.

Issues

Maintainers will keep adding issues for scripts that are widely used or requested and you can choose to work on these. Before starting work on an issue please leave a coment so the maintainer can assign you the issue. Kindly avoid creating PRs for issues that have already been assigned to someone else. If you are not sure if an issue is already assigned to someone else please ask.

How to fork and PR

  1. Fork the repo.
  2. Clone the forked repo using
git clone <repo_url>
  1. Create a new branch for your PR using
git checkout -b <branch_name>

Note: This should always be done from the main branch which is up-to-date with upstream.

  1. Write your code in the new branch.
  2. Add the changes to the staging area using
git add <file_name>
  1. Commit the changes using
git commit -m "message"

Note: Please use sensible commit messages.

  1. Push your code to the remote repo.
git push origin <branch_name>
  1. Create a PR by going to the repo's page and clicking the "New pull request" button. Please make sure your PR title and description are descriptive and self explanatory.

File Structure

Add the scripts in folders named after their functionality. Please try to write modular scripts that can be reused by others easily.

PR guidelines

  1. Codes must be general purpose and re-usable (We do not want codes specific to your assignment xD).
  2. Documentation PRs are acceptable.
  3. Merging of PRs will be at maintainer's discretion.

Hacktoberfest specific guidelines

  1. The PRs must follow the hacktober fest guidelines which can be found here.
  2. Any valid PR will be hacktoberfest-approved but may not necessarily be merged into the repo.
  3. Do not submit PRs for duplicates of scripts that are already present in the repo. You can however make changes to existing code.
  4. Do not copy scripts from other repositories or websites. Your PR will be marked as invalid if you do so.