Add CONTRIBUTING file #55
Conversation
| <a href="#pull-request-submissions"></a> | ||
| ## Pull Request Submissions. | ||
|
|
||
| Pull Requests should contain the issue you are solving as well as a description about your fix. Before submitting a pull request, please confirm that merge issues are resolved. |
|
|
||
| We use [Swiftlint](https://github.com/realm/SwiftLint) to enforce coding rules. The rules can be found in the `.swiftlint.yaml` file in the root folder of the project. Please make sure you don't have any warning or error before submitting the Pull Request. | ||
|
|
||
| Documentation and tests are very important. When you submit a Pull Request, please keep the documentation update and try to improve the project's tests. For instance, if you fix a bug, a good idea is to add tests that are aimed to confirm that the issues has been solved and avoid future regressions. |
| ## Reporting Issues | ||
|
|
||
| A great way to contribute to the project | ||
| is to send a detailed issue when you encounter an problem. |
| <a href="#pull-request-submissions"></a> | ||
| ## Pull Request Submissions. | ||
|
|
||
| Pull Requests should contain the issue you are solving as well as a description about your fix. Before submitting a pull request, please confirm that merge issues are resolved. |
There was a problem hiding this comment.
confirm == make sure? Or you really mean "Confirm"?
a description about your fix. ==> description about your implementation/solution.?
|
|
||
| Pull Requests should contain the issue you are solving as well as a description about your fix. Before submitting a pull request, please confirm that merge issues are resolved. | ||
|
|
||
| We use [Swiftlint](https://github.com/realm/SwiftLint) to enforce coding rules. The rules can be found in the `.swiftlint.yaml` file in the root folder of the project. Please make sure you don't have any warning or error before submitting the Pull Request. |
There was a problem hiding this comment.
.swiftlint.yaml => .swiftlint.yml
|
|
||
| We use [Swiftlint](https://github.com/realm/SwiftLint) to enforce coding rules. The rules can be found in the `.swiftlint.yaml` file in the root folder of the project. Please make sure you don't have any warning or error before submitting the Pull Request. | ||
|
|
||
| Documentation and tests are very important. When you submit a Pull Request, please keep the documentation update and try to improve the project's tests. For instance, if you fix a bug, a good idea is to add tests that are aimed to confirm that the issues has been solved and avoid future regressions. |
There was a problem hiding this comment.
please keep the documentation update => please keep the documentation updated
try to improve the project's tests => Implement the appropriated tests,
confirm that the issues has been solved => confirm that the issue has been solved
| <a href="#asking-questions"></a> | ||
| ## Asking Questions | ||
|
|
||
| Feel free to [open an issue](https://github.com/BendingSpoons/katana-lib-swift/issues/new) for any doubt or feature request related to Katana. |
There was a problem hiding this comment.
for any doubt, are we sure? Maybe we should limit the questions within the issues and rely on Stack Overflow (as stated here after). I'd limit issues for feature requests, bugs and potentially philosophical discussions about architecture.
|
|
||
| Feel free to [open an issue](https://github.com/BendingSpoons/katana-lib-swift/issues/new) for any doubt or feature request related to Katana. | ||
|
|
||
| For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](http://stackoverflow.com/questions/tagged/swift) instead. By doing so, you'll be more likely to quickly solve your problem, and you'll allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others. |
There was a problem hiding this comment.
that are not specific to the project itself it's not clear to me. I'd just remove this: usage questions go to Stack Overflow, the rest on issues
| <a href="#reporting-issues"></a> | ||
| ## Reporting Issues | ||
|
|
||
| A great way to contribute to the project |
There was a problem hiding this comment.
There are a bit of unnecessary newlines here, isn't it?
Fix #41