diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4844b432b12f..e8343fe0e8f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We are pleased that you are thinking about contributing to OpenProject! This gui ## Get in touch -Please get in touch with us using our [develompment forum](https://community.openproject.org/projects/openproject/boards/7) or send us an email to info@openproject.com. +Please get in touch with us using our [development forum](https://community.openproject.org/projects/openproject/boards/7) or send us an email to info@openproject.com. ## Issue tracking and coordination @@ -61,7 +61,7 @@ git push origin - Create a pull request against a branch of of the repository, containing a ***clear description*** of what the pull request attempts to change and/or fix. -If your pull request **does not contain a description** for what it does and what it's intentions are, +If your pull request **does not contain a description** for what it does and what its intentions are, we will reject it. If you are working on a specific work package from the [list](https://community.openproject.org/projects/openproject/work_packages), you may include a link to that work package in the description, so we can track your work. @@ -83,12 +83,10 @@ More on this topic can be found in our [blog post](https://www.openproject.org/h Please add tests to your code to verify functionality, especially if it is a new feature. -Pull requests will be verified by TravisCI as well, +Pull requests will be verified by GitHub Actions as well, but please run them locally as well and make sure they are green before creating your pull request. We have a lot of pull requests coming in and it takes some time to run the complete suite for each one. -If you push to your branch in quick succession, please consider stopping the associated Travis builds, as Travis will run for each commit. This is especially true if you force push to the branch. - Please also use `[ci skip]` in your commit message to suppress builds which are not necessary (e.g. after fixing a typo in the `README`). @@ -100,11 +98,11 @@ A fix for the current version (called "Hotfix" and the branch ideally being name should target `release/*` and a fix for the former version (called "Backport" and the branch ideally being named `backport/XYZ`) should target `backport/*`. We will try to merge hotfixes into dev branch -but if that is no trivial task, we might ask you to create another PR for that. +but if that is a non-trivial task, we might ask you to create another PR for that. ## Inactive pull requests -We want to keep the Pull request list as cleaned up as possible - we will aim close pull requests +We want to keep the Pull request list as tidy as possible - we will aim close pull requests after an **inactivity period of 30 days** (no comments, no further pushes) which are not labelled as `work in progress` by us.