Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

76 lines (54 loc) · 3.38 KB
Raw

Guidelines for contributing to this challenge

This repo is part of the inspirezone.tech community portfolio of projects located on our GitHub page

Inspirezone is an online tech blog and community that focuses on encouraging developers of all levels of experience to improve their skills through online collaboration.

Consider joining the inspirezone community here! You don't have to join to contribute to this project. However, joining will give you a number of advantages such as:

  • Access to member exclusive channels on the inspirezone Discord server
  • Join in discussions with other members and take part in events
  • Be part of an accountability group that will encourage you to code more
  • Get notified of other projects and activities within our community
  • It's fun to improve your skills by working with others!

Preparing your contribution

  • Make sure you've read the README on this repo first
  • Then follow the challenge rules and code up your entry!
  • Create your README.md file with instructions for your program. This includes: required installations, libraries, dependencies, how to execute the program.
  • Create a folder named with your GitHub username and place it on the root of the repo e.g.
    your-github-name/
  • Place your source files and README.md inside the folder e.g.
    your-github-name/your-code.py your-github-name/README.md
  • You're now ready to submit your entry!

How to submit your code to this repository - step by step guide

Please use pull requests to submit your contribution.

If you're new to opensource and contributing, for a bit of help getting started see this post on the inspirezone blog:
A beginner friendly guide to making your first open source contribution.

Steps to make your contribution using git commands

1. Fork this repo. Click on the fork icon on this repo to create a copy of it on your GitHub profile

github fork icon

2. Clone the forked repo to your PC

git clone https://github.com/your-github-username/Calculator-Challenge-Inspirezone.git

3. Add this repo as the remote upstream. Keep it synced regularly by pulling from upstream

git remote add upstream https://github.com/inspirezonetech/Calculator-Challenge-Inspirezone.git

git pull upstream main

4. Create a new branch and checkout to the branch

 git checkout -b your-branch

5. Get coding!

6. Commit your changes

git commit -m "commit message describing change"

7. Push to your Fork

git push origin your-branch

8. Create a Pull Request. Go to your Fork on GitHub and create a pull request to this repo on GitHub. Then fill in the PR submission form before submitting

github fork icon

9. If needed, respond to code review comments and feedback

10. If all goes well, your submission will be merged. Congrats!

License

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