From 1dd887ec9bcdc628d1426d077ee7ee8857a15fbd Mon Sep 17 00:00:00 2001 From: Simone Martorelli Date: Mon, 18 Jan 2021 16:21:52 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 926a2e4..f66887f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,10 @@ Our project welcomes external contributions. If you have an itch, please feel free to scratch it. -To contribute code or documentation, please submit a **FIXME** [pull request](https://github.com/ibm/repo-template/pulls). +To contribute code or documentation, please submit a [pull request](https://github.com/ibm/mac-ibm-enrollment-app/pulls). A good way to familiarize yourself with the codebase and contribution process is -to look for and tackle low-hanging fruit in the **FIXME** [issue tracker](https://github.com/ibm/repo-template/issues). +to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/ibm/mac-ibm-enrollment-app/issues). Before embarking on a more ambitious contribution, please quickly [get in touch](#communication) with us. **Note: We appreciate your effort, and want to avoid a situation where a contribution @@ -14,14 +14,14 @@ cannot be accepted at all!** ### Proposing new features -If you would like to implement a new feature, please **FIXME** [raise an issue](https://github.com/ibm/repo-template/issues) +If you would like to implement a new feature, please [raise an issue](https://github.com/IBM/mac-ibm-enrollment-app/issues/new?assignees=&labels=&template=feature_request.md&title=) before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base. ### Fixing bugs -If you would like to fix a bug, please **FIXME** [raise an issue](https://github.ibm.com/chrisfer/social-coding/issues) before sending a +If you would like to fix a bug, please [raise an issue](https://github.com/IBM/mac-ibm-enrollment-app/issues/new?assignees=&labels=&template=bug_report.md&title=) before sending a pull request so it can be tracked. ### Merge approval @@ -68,16 +68,10 @@ git commit -s ``` ## Communication -**FIXME** Please feel free to connect with us on our [Slack channel](link). - -## Setup -**FIXME** Please add any special setup instructions for your project to help the developer -become productive quickly. +Please feel free to connect with us by mail, see the [MAINTAINERS.md](MAINTAINERS.md) page. ## Testing -**FIXME** Please provide information that helps the developer test any changes they make -before submitting. +Make sure that every Xcode Unit and UI test pass befor submitting any changes. ## Coding style guidelines -**FIXME** Optional, but recommended: please share any specific style guidelines you might -have for your project. +Please follow the SwiftLintFramework rules.