Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.85 KB

Contributing to EvrimNews

First of all, thanks for your interest in Contributing to EvrimNews 🎊🎉.

We want to remember you that EvrimNews is a private project that you can contribute only for typo fixes. Code fixes are not accepted. But, if you've fixed a problem on the issue list, you can open a PR so we can check whether it's mergeble, or not.

The reason we limit contributions for this project is that there is a team working on this app. To not interrupt their work, only typo fixes are accepted as mentioned above.

But as mentioned below, if you've fixed anything on the issue list, you can always submit a PR.

How to contribute to EvrimNews for code fixes 🔧

Step 1: Find an issue that you can fix 🔧

From the issues list (https://github.com/ozelevrim/EvrimNews/issues) choose an issue that you can contribute to. The issues list is not limited to only bugs but also feature requests. You can filter bugs or feature requests using Labels.

Step 2: Download the project as .zip (or clone it if you want) ⬇️

Clone EvrimNews to your computer and launch with Android Studio. After launching it, try to fix or add the features mentioned in the issues list.

Step 3: Project Ready? Fork the project on GitHub to your profile 🍴

Fork EvrimNews to your profile by clicking the fork button at the top right.

Step 4: Upload the project to your (forked) repo ⬆️

Upload the project you've created with Android Studio to your forked repo.

Step 5: Create a PR (Pull Request) ⚙️

For us to merge your forked repo with the master repo, you will need to create a PR. Go to your forked repo and then click create a new pull request. Then, enter useful information that can help us for the approval procedure.

Step 6: Wait! ⏰

The waiting procedure will take so short. We normally check our PR's almost everyday, so your PR request will get

  • An approval, ✅
  • A disapproval, ❌
  • or a request change ⭕️

depending on the files you've added or removed.

How to contribute to EvrimNews for typo fixes 🅰️

It's so simple compared to contributing to EvrimNews for code fixes. 👍

Step 1: Find the file on the master repo (without forking) that you want to change

Find the file on the master repo (Without forking) that you want to change. You can also fork the project if you want to make multiple changes on multiple files.

Step 2: Make the changes

Make the changes on the files you want to change.

Step 3: Create a new branch and make a PR ⚙️

After you've done your changes for commiting your changes, you will have the option to create a PR. The branch will be called patch-1 automatically.

Step 4: Wait! ⏰

The waiting procedure will take so short. We normally check our PR's almost everyday, so your PR request will get

  • An approval,
  • A disapproval,
  • or a request change

depending on the files you've added or removed.