diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b429600 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +- [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. + +## 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) + +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