search

Avdan-OS / Compositor

Rusty AvdanOS Wayland compositor
GNU General Public License v3.0
22 stars 12 forks source link

Updated contributing.md #12

Closed Rohith0009 closed 2 years ago

Rohith0009 commented 2 years ago

Updated contributing.md by adding more documentation, updated bug_report.md and readme.md

Contributing.md Looks Like This:

Contributing Guideline

Basics

To start your contribution, please follow the steps below:

  1. Create a fork of this repo

  2. Git clone your fork to your machine

git clone url://to.your/github/fork.git
  1. Use dev branch, commits targetting main will be ignored.
git checkout -b dev remotes/upstream/dev

  1. Make changes as you want

  2. Commit your changes

git commit -m "concise message of the change"

Tip: you can set up code signing and add -S to the commit command above to get a verified check mark

  1. Push your changes
git push
  1. Create pull request on GitHub

No Direct Commits

Follow the Rust Styling Guideline

Froxcey commented 2 years ago

Any contribution to main branch will be ignored? Maybe not this one? If then, I will add a LGTM.

Rohith0009 commented 2 years ago

Any contribution to main branch will be ignored? Maybe not this one? If then, I will add a LGTM.

I Commited to main because the bug_report was not on the dev branch it was only on the main branch otherwise I will do only to the dev branch. I had no choice!