├── .DS_Store ├── FAQS.md ├── Contributors.md ├── .github └── FUNDING.yml ├── CONTRIBUTING.md ├── LICENSE ├── CODE_OF_CONDUCT.md └── README.md /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/osckampala/First-contribution-practice/HEAD/.DS_Store -------------------------------------------------------------------------------- /FAQS.md: -------------------------------------------------------------------------------- 1 | # Frequently Asked Questions 2 | 3 | ## 1. Where and how do I clone? 4 | ## 2. Does reviewing a private repository of an NGO make it open source 5 | -------------------------------------------------------------------------------- /Contributors.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # **Contributors** 4 | 5 | - [Benjamin Rukundo](https://github.com/rukundob451) 6 | - [Hassan Bahati Mukisa](https://github.com/HassanBahati) 7 | - [Humphrey Galiwango](https://github.com/Humphrey-Galiwango99) 8 | - [Simon Peter Mujuni](https://github.com/sp-mujuni) 9 | - [Nabil Lubega](https://github.com/nklubega) 10 | - [Pius Tumwebaze](https://github.com/Vladmir-dev) 11 | - [Humphrey Okoth](https://github.com/humphreyokoth) 12 | - [Fred Vuni](https://github.com/FREDVUNI) 13 | - [Rodrick Calvin Wamala](https://github.com/rodrickcalvin) 14 | - [Karan Chandekar](https://github.com/KaranChandekar) 15 | - PATRICK FITZ 16 | - [Kisakye Moses](https://github.com/moses-kisakye) 17 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: osca-kampala 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | We love pull requests from everyone. By participating in this project, you 4 | agree to abide by the [Contributor Covenant](http://contributor-covenant.org). 5 | 6 | ## Steps 7 | 8 | 1. [Fork](https://help.github.com/articles/fork-a-repo/) this project 9 | 2. [Clone](https://help.github.com/articles/fork-a-repo/#step-2-create-a-local-clone-of-your-fork) your forked version `git clone git@github.com:/First-contribution-practice.git` 10 | 3. Make changes 11 | 4. [Commit](https://help.github.com/articles/adding-a-file-to-a-repository-using-the-command-line/) your changes (write a short descriptive message of what you have done) 12 | 5. [Push](https://help.github.com/articles/pushing-to-a-remote/) your changes to your forked version 13 | 6. Go to original project on GitHub & Create a [Pull Request](https://help.github.com/articles/about-pull-requests/) 14 | 15 | **DONE** 16 | 17 | 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Open Source Community Africa - Kampala Chapter 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | ## Our Standards 8 | 9 | Examples of behavior that contributes to creating a positive environment include: 10 | 11 | - Using welcoming and inclusive language 12 | - Being respectful of differing viewpoints and experiences 13 | - Gracefully accepting constructive criticism 14 | - Focusing on what is best for the community 15 | - Showing empathy towards other community members 16 | 17 | Examples of unacceptable behavior by participants include: 18 | 19 | - The use of sexualized language or imagery and unwelcome sexual attention or advances 20 | - Trolling, insulting/derogatory comments, and personal or political attacks 21 | - Public or private harassment 22 | - Publishing others' private information, such as a physical or electronic address, without explicit permission 23 | - Other conduct which could reasonably be considered inappropriate in a professional setting 24 | 25 | ## Our Responsibilities 26 | 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 28 | 29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 30 | 31 | ## Scope 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 34 | 35 | ## Enforcement 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at oscakampala@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality concerning the reporter of an incident. Further details of specific enforcement policies may be posted separately. 38 | 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 40 | 41 | ## Attribution 42 | 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 44 | 45 | [homepage]: http://contributor-covenant.org 46 | [version]: http://contributor-covenant.org/version/1/4/ 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) 2 | [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) 3 | [![Open Source Helpers](https://www.codetriage.com/roshanjossey/first-contributions/badges/users.svg)](https://www.codetriage.com/roshanjossey/first-contributions) 4 | 5 | # First-contributions-practice 6 | 7 | This project aims to simplify and guide the way beginners make their first contribution. If you are looking to make your first contribution, follow the steps below to practise making a [Pull Request(PR)](https://github.com/OSCA-Kampala-Chapter/First-contribution-practice/compare). 8 | 9 | Questions can be asked by raising a [Discussion](https://github.com/OSCA-Kampala-Chapter/First-contribution-practice/discussions) with a `Q&A` Category tag. Click [New Discussion](https://github.com/OSCA-Kampala-Chapter/First-contribution-practice/discussions/new) 10 | 11 | Issues arising from using this repository's code can be outlined under the [Issues](https://github.com/OSCA-Kampala-Chapter/First-contribution-practice/discussions) tab 12 | 13 | **Just add your name to the alphabetical list in [Contributors.md](./Contributors.md) and optionally, a link to your GitHub account** 14 | 15 | # How to contribute 16 | 17 | fork this repository 18 | 19 | ### If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/) 20 | 21 | ## Fork this repository 22 | 23 | Fork this repository by clicking on the fork button on the top of this page. 24 | This will create a copy of this repository in your account. 25 | 26 | ## Clone forked repository and make changes locally 27 | 28 | clone this repository 29 | 30 | Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. Its now yours to play around with 31 | 32 | Open a terminal and run the following git command: 33 | 34 | ``` 35 | git clone https://github.com/yourGithubUsername/First-contribution-practice.git 36 | ``` 37 | 38 | This will download the forked copy of this repo to your computer 39 | copy URL to clipboard 40 | 41 | For example: 42 | 43 | ``` 44 | git clone https://github.com/this-is-you/first-contributions.git 45 | ``` 46 | 47 | where `this-is-you` is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer. 48 | 49 | 50 | ## Create a branch 51 | 52 | Switch to the cloned folder. This can be done with Gitbash or the integrated terminal in the VSCode editor 53 | 54 | Open the file `README.md` in your text editor such as VS Code 55 | 56 | ```bash 57 | cd First-contribution-practice 58 | ``` 59 | 60 | Now create a branch using the `git checkout` command: 61 | 62 | Your name would make a good branch because it's unique 63 | 64 | ```bash 65 | git checkout -b 66 | ``` 67 | 68 | For example: 69 | 70 | ```bash 71 | git checkout -b add-jerry-abraham 72 | ``` 73 | 74 | 75 | ## Make necessary changes and commit those changes 76 | 77 | 78 | Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file. 79 | 80 | git status 81 | 82 | If you go to the project directory and execute the command `git status`, you'll see there are changes. 83 | 84 | Add those changes to the branch you just created using the `git add` command: 85 | 86 | ```bash 87 | git add Contributors.md 88 | ``` 89 | 90 | You can also add all the changes, by using the command below: 91 | 92 | ```bash 93 | git add . 94 | ``` 95 | 96 | Now commit those changes using the `git commit` command: 97 | 98 | ```bash 99 | git commit -m "Add to Contributors list" 100 | ``` 101 | 102 | replacing `` with your name. 103 | 104 | ## Push changes to GitHub 105 | 106 | Push your changes using the command `git push`: 107 | 108 | ```bash 109 | git push origin 110 | ``` 111 | 112 | replacing `` with the name of the branch you created earlier. 113 | 114 | ## Submit your changes for review 115 | 116 | If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. 117 | 118 | create a pull request 119 | 120 | Now submit the pull request. 121 | 122 | submit pull request 123 | 124 | Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged. 125 | 126 | ## Where to go from here? 127 | 128 | Congrats! You just completed the standard _fork -> clone -> edit -> pull request_ workflow that you'll encounter often as a contributor! 129 | 130 | Celebrate your contribution and share it with your friends and followers 131 | 132 | Now let's get you started with contributing to other projects. We've compiled a list of projects with easy issues you can get started on. Check out [the list of projects in the web app](https://firstcontributions.github.io/#project-list). 133 | 134 | --- 135 | 136 | ## What if I have a Conflict? 137 | 138 | #### A GitHub conflict is when people make changes to the same area or line in a file. This must be fixed before it is merged in order to prevent collision in the main branch. 139 | 140 | - #### To read more about this, go to [Github Docs - About Merge Conflicts](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts) 141 | - #### To find out about how to fix a Git Conflict, go to [Github Docs - Resolve Merge Conflict](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) 142 | 143 | --- 144 | --------------------------------------------------------------------------------