Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dennyabrain authored Oct 4, 2023
1 parent 5da9941 commit 919e12b
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@

Firstly we are really grateful to you that you are considering contributing to Uli. We welcome contributions of all sorts - filing a bug report, suggesting improvements, proposing new feature, adding documentations, writing tests etc.

By contributing to Uli, you are agreeing to our community guidelines (will be linked soon)
By contributing to Uli, you are agreeing to our [community guidelines](https://github.com/tattle-made/Uli/blob/main/CODE_OF_CONDUCT.md)

Contributing to Uli takes 4 easy steps

👋 Say Hi

🔨 Do your thing

📞 Tell us

🎉 Celebrate

---
Expand All @@ -20,21 +17,23 @@ Contributing to Uli takes 4 easy steps

The very first thing you should do is letting us know that you are interested in contributing by the following means :

If you are unsure about how to contribute to Uli, simply join our slack and introduce yourself and mention what interests you about the project. We'll reach out and assist you further.
If you are unsure about how to contribute to Uli, simply join our [slack](https://admin417477.typeform.com/to/nVuNyG?typeform-source=tattle.co.in), introduce yourself and mention what interests you about the project. We'll reach out and assist you further.

If there's a particular improvement you want to suggest, or a bug in kosh you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.
If there's a particular improvement or feature you want to suggest, or a bug in Uli you want to fix, simply create a Github Issue regarding it and we'll reach out to assist you further.

If you are interested in knowing what we are working on right now, head over to the [project page](https://github.com/orgs/tattle-made/projects/30). If any issue there interests you, comment on it for any clarification.

If you are leaning towards working on our codebase, you might find our [learning guide](https://github.com/tattle-made/Uli/wiki/Uli-Learning-Guide) useful. This will help you expedite whatever you need to learn to be an effective contributor.

# 🔨 Do your thing
You should be able to run Uli on your own machine by following the instructions [here](../README.md). Find a github issue and make changes in the codebase to address the issue.
You should be able to run Uli on your own machine by following the instructions on one of our [setup guides](https://github.com/tattle-made/Uli/wiki/Setup-Uli-on-Linux-for-Chrome). If you prefer, we have a [video tutorial](https://www.youtube.com/watch?v=fwSnEe3-fL8) as well. Once you have identified the issue you want to work on, make a fork of our repository and get to coding.


## Pair programming

We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you.
We offer pair programming sessions with community members to familiarize them with the product and the code base. This will give you an opportunity to clarify any doubts regarding the codebase and the features that interest you. Do ping us on the issue or on slack if you would like to sign up for it.

# 📞 Tell us
# 📞 Tell us via Pull Request

All code changes happen via pull request. We use [Github Flow](https://guides.github.com/introduction/flow/). The easiest way to let us know if you want to combine your changes into the core code is to make a Pull Request (PR)

Expand All @@ -47,7 +46,7 @@ We don't strictly follow test driven development (TDD) but any contributions tha

# 🎉 Celebrate

We typically review a PR within 2-3 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂
We typically review a PR within 2-5 days. We might offer you some feedback to your PR and merge it! If you reached till this stage, Congratulations and join us afterwards for virtual coffee/tea on slack 🙂

# Licence

Expand Down

0 comments on commit 919e12b

Please sign in to comment.