Skip to content

Commit

Permalink
Add how to contribute:
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed Aug 19, 2024
1 parent 894d321 commit 3071e57
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

Thanks for considering to contribute and reading this!

Here we discuss how to contribute

- [Spoken text](#spoken-text), e.g. ideas, feedback, messages, etc. and are written in English.

Check failure on line 7 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / check_markdown

Line length [Expected: 80; Actual: 95]
- [Code](#code), e.g. textual changes where the text is formatted in Markdown

## Spoken text

Spoken text are ideas, feedback, messages, etc. and are written in English.

For ideas or feedback, create an [Issue](https://github.com/UPPMAX/uppmax_intro_python/issues).
These Issues will be discussed in a meeting and/or below that Issue.

Ideas that improve the experience of UPPMAX users trying to use our resources will likely be accepted.

Check failure on line 17 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / check_markdown

Line length [Expected: 80; Actual: 102]

## Code

We welcome any contribution that:

- improves the experience of our learners
- follow all standards set by the continuous integration tools (e.g. use 4 spaces for indentation)

Check failure on line 24 in CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / check_markdown

Line length [Expected: 80; Actual: 98]

As an UPPMAX contributor, one can contribute by:

1. Clone this repository
1. Add a branch
1. Work on your branch
1. When done, create a Pull Request from your branch to `main`
1. If the change is accepted after review it will be merged into the main branch
1. Your branch will be deleted after merging

As an external contributor, one can contribute by:

1. Fork this repository
1. Modify your Fork
1. When done, creating a Pull Request from your Fork to this repository,
merging to the `main` branch is fine :-)
1. If the change is accepted after review it will be merged into the main branch

0 comments on commit 3071e57

Please sign in to comment.