Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

114 lines (78 loc) · 4.36 KB
Raw

Contribution Guidelines

We love your input! We want you to make contribution to this repository in the easiest and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Contributing

NOTE - NOT more than 2 issues will be assigned at any given point in time.

Different types of contribution practices for this repository -

1) Add a calculator description and provide the code for the same

*provided the calculator description has NOT been created earlier in this repository, so kindly go through the repository before raising an issue.
  • Steps -
    Step a) Click on Issues tab
    Step b) Click on New Issue button
    Step c) Click Get Started button
    Step d) Fill a short description form
    Step e) Press Submit New Issue button
    Step f) Now Comment - "Kindly assign this issue to me"
    *issue will be assigned to the participant who comments - "Kindly assign this issue to me" on first-come-first-serve basis.
    Step g) Press on Comment button
    Step h) Wait for the issue to be assigned to you.
    *working on the issue that has not been assigned to you will result in rejection of the PR.
    Step i) After the issue get assigned to you.
    You'll also receive my comment stating in which folder the solution needs to be placed as well as the deadline for solution submission.
    Step j) Now you can workout the solution and generate PR(Pull request).

2) Provide the code for an open issue

  • Steps -
    Step a) Click on Issues tab
    Step b) Click on one of the issues which has not been assigned to anyone
    Step c) Read the calculator description throughly
    Step d) If know are clear with the description then Comment - "Kindly assign this issue to me"
    Step e) Press on Comment button
    Step f) Wait for the issue to be assigned to you.
    *working on the issue that has not been assigned to you will result in rejection of the PR.
    Step g) After the issue get assigned to you.
    You'll also receive my comment stating in which folder the solution needs to be placed as well as the deadline for solution submission.
    Step h) Now you can workout the solution and generate PR(Pull request)

3) Add a calculator description

*provided the calculator description has NOT been created earlier in this repository, so kindly go through the repository before raising an issue.
  • Steps -
    Step a) Click on Issues tab
    Step b) Click on New Issue button
    Step c) Click Get Started button
    Step d) Fill a short description form
    Step e) Press Submit New Issue button

NOTE - NOT folowing the contribution guidlines may lead to permanent ban from repository.


In general, we follow the "fork-and-pull" Git workflow.
  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push the code
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Issues

Feel free to submit issues and enhancement requests.

Issues are very valuable to this project.

  • Ideas are a valuable source of contribution
  • Problems show where this project is lacking
  • With a question you show where contributors can improve the user experience

Pull Requests

Pull requests are, a great way to get your ideas into this repository.

When deciding if I merge in a pull request I look at the following things:

Does it state intent

You should be clear which problem you're trying to solve with your contribution.

For example:

Creating an empty array ❌

Doesn't tell me anything about why you're doing that

Creating an empty array to store user entered values ✔

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.

Is it of good quality

  • There are no spelling mistakes
  • Has readability

Does it move this repository closer to my vision for the repository

The aim of this repository is:

  • To provide calcultors for educational and professional purposes.
  • The content is usable by someone who hasn't written something like this before.
  • Foster a culture of respect and gratitude in the open source community.