Skip to content
This repository has been archived by the owner on Aug 29, 2022. It is now read-only.

Latest commit

 

History

History
82 lines (48 loc) · 4.83 KB

CONTRIBUTING.md

File metadata and controls

82 lines (48 loc) · 4.83 KB
Raw

Welcome to Codinasion contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on codinasion.vercel.app/programme ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Check to see what types of contributions we accept before making changes ✨.

Issues

Create a new issue

If you want to add or modify Codinasion content, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue template.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in the UI

Click Edit in GitHub at the top of any Codinasion webpage to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Make changes locally

  1. Fork the repository.

  2. Clone the forked repository.

git clone https://github.com/your_username/codinasion-programme
  1. Create a working branch and start with your changes!
git checkout -b your-new-branch-name

Add Content

  • Add or modify programme file (.py, .c, .cpp, etc) in corresponding folder.

Commit your update

Commit the changes once you are happy with them.

Once your changes are ready, don't forget to self-review to speed up the review process ⚡

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Codinasion team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The Codinasion team thanks you ✨

Once your PR is merged, your contributions will be publicly visible on the codinasion.vercel.app/programme

Now that you are part of the Codinasion community, see how else you can contribute to codinasion