Skip to content

Latest commit

 

History

History
136 lines (94 loc) · 5.53 KB

CONTRIBUTING.md

File metadata and controls

136 lines (94 loc) · 5.53 KB
Raw

Contributing to Github Readme Activity Graph

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

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

Before you contribute

Our aim is to keep it simple for the developers to contribute to this project. See the folder structure (with concise description)

How to contribute

  1. First up you need to fork (make a copy) of this repo to your Github account.

  2. Clone (download) your fork to your computer

  3. Set your streams so you can sync your clone with the original repo (get the latest updates)

    • git remote add upstream https://github.com/Ashutosh00710/github-readme-activity-graph
    • git pull upstream main
    • The above 2 commands will synchronize your forked version of the project with the actual repository.

  4. Create a branch git checkout -b <your_branch_name>.

  5. Generate your personal access token

  6. Create a .env file in the root directory and in there write
    TOKEN=<your_generated_token>

    Now, open your terminal and write the following commands:

    • npm install (install the dependencies)
    • npm start (run the project on localhost)

  7. Get a screenshot of your finished work! (if there are any UI changes) Try to crop it so that it looks good as a smallish (preferably squarish) image.

  8. Pull from the upstream again before you commit your changes as you did in step 3. This is to ensure you still have the latest code.

  9. If you see an error like

    Your local changes to the following files would be overwritten by merge. Please commit your changes or stash them before you merge

    on using git pull upstream main use:

    • git stash
    • git pull upstream main
    • git stash pop

    for more info on this visit

  10. Commit and push the code to your fork

  11. Create a pull request to have the changes merged from your fork into the origin.

Folder Structure


├── ...
├── .github                          #conatins issues and pull request templates
│ ├── ISSUE_TEMPLATE
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ └── PULL_REQUEST_TEMPLATE.md
├── __test__                         #conatins test for the project
│ ├── utils.test.js                  #tests for functions in src/utils.ts
│ ├── svgs.test.js                   #tests for functions in src/svgs.ts
│ ├── mockFunctions.js               #contains mock functions for fetching.test.js
│ ├── fetching.test.js               #tests for functions in src/fetching.ts
│ └── fakeInputs.js                  #conatins fake inputs for tests
├── asset                            #contains logo and screenshots of graphs
├── interfaces
│ └── interface.ts                   #contains all used interfaces throughout the code
├── types
│ └── types.ts                       #contains all used types throughout the code
├── src
│ ├── createChart.ts                 #creation of graph with chartist.js and node-chartist
│ ├── GraphChards.ts                 #class of Graph Cards
│ ├── main.ts                        #everything starts from here
│ ├── svgs.ts                        #contains svgs used or created throughout the project
│ └── utils.ts                       #contains utility functions
├── styles
│ ├── graphAnimation.ts              #contains all the animations of the graph
│ ├── graphStyle.ts                  #contains style(CSS) of the graph
│ └── themes.ts                      #all the themes are here
├── ...

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If your change needs an explanation to the user, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give a sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Observe the coding style of the project and add your code also in the same style. Don't make major changes (Like changing the complete folder structure)

License

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