Skip to content

Commit

Permalink
chore: update related documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Akuukis committed Nov 4, 2024
1 parent af7d901 commit a211373
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
17 changes: 14 additions & 3 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@
.git-blame-ignore-revs @magicznyleszek
.gitattributes @magicznyleszek @noliveleger
.gitignore @magicznyleszek @noliveleger
CONTRIBUTING.md @magicznyleszek @noliveleger
dependabot.yml @magicznyleszek
kpi.code-workspace @p2edwards
LICENSE @jnm @tinok
README.md @jnm @magicznyleszek @noliveleger

## Translations
.gitmodules @JacquelineMorrissette @jnm
Expand Down Expand Up @@ -82,11 +80,24 @@ pyproject.toml @jnm @noliveleger


################
#### Infra section
#### Infrastructure section

docker/* @bufke @jnm @noliveleger
scripts/* @bufke @jnm @noliveleger
.github/* @bufke @jnm @noliveleger @magicznyleszek
.gitlab-ci.yml @bufke
Dockerfile @bufke @jnm @noliveleger




################
#### Documentation section
CONTRIBUTING.md @Akuukis @magicznyleszek @noliveleger
README.md @Akuukis @jnm @magicznyleszek @noliveleger
.github/CODEOWNERS.md @Akuukis @jnm @noliveleger @magicznyleszek
.github/FUNDING.md @Akuukis @jnm @noliveleger @magicznyleszek
.github/ISSUE_TEMPLATE.md @Akuukis @jnm @noliveleger @magicznyleszek
.github/PULL_REQUEST_TEMPLATE.md @Akuukis @jnm @noliveleger @magicznyleszek


10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,22 @@ We'd love your input! We want to make contributing to this project as easy and t

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
## All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://docs.github.com/en/get-started/using-github/github-flow)).
We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update (or create!) the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!
6. Issue that pull request and follow the pull request template!

## Any contributions you make will be under the GNU Affero General Public License

In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License](./LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License](./LICENSE) that covers the project.
Feel free to contact the maintainers if that's a concern.

## Report bugs using GitHub's [issues](https://github.com/kobotoolbox/kpi/issues)

Expand Down

0 comments on commit a211373

Please sign in to comment.