From 748e21f81cb52ec83a77a0235b627f10a659d4bf Mon Sep 17 00:00:00 2001 From: Ellie Kelsch Date: Wed, 20 Dec 2023 12:14:29 +0000 Subject: [PATCH 1/2] docs: add contributing guide to library --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5e2b01d0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing to the github-java-client + +Thanks for your interest in the github-java-client. Our goal is to bring a reliable Java-based +alternative to the GitHub API. + +## Getting Started + +The Github Java Clients's [open issues are here](https://github.com/github-java-client/github-java-client/issues). +In time, we'll tag issues that would make a good first pull request for new contributors. An easy +way to get started helping the project is to *file an issue*. Issues can include bugs to fix, +features to add, or documentation that looks outdated. + +## Contributions + +This project welcomes contributions from everyone. + +Contributions to github-java-client should be made in the form of GitHub pull requests. Each pull +request will be reviewed by a maintainer of the library and either merged and released or given +feedback for changes that would be required. + +## Pull Request Checklist + +- Branch from the master branch and, if needed, rebase to the current master branch before + submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase + your changes. +- Commits should be as small as possible while ensuring that each commit is valid independently + (i.e. each commit should compile and the tests should pass). +- Add tests relevant to the fixed bug or new feature. We love to increase our test coverage so any + contributions made to improving that will be very welcomed. + +## Coding standards + +- This library is modelled after the [GitHub API](https://docs.github.com/en/rest?apiVersion=2022-11-28) and it has been structured to mimic that. + For example, to access the Teams endpoints, you need to instantiate an Organisation Client + and then a Teams Client as [seen here](./src/main/java/com/spotify/github/v3/clients/OrganisationClient.java). This mirrors the nested structure of the API endpoints such as the + [/orgs/{org}/teams/{team_slug}](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams) endpoint +- We operate a monkey see, monkey do approach to this library. We understand that there are some inconsistencies in the library + in terms of how the tests and/or endpoints are written but we, with your help, are working on creating +- All bug fixes and new features need to be fully tested. \ No newline at end of file From c28468e9be18748f636d2e518f86b6b626f23cb3 Mon Sep 17 00:00:00 2001 From: Ellie Kelsch Date: Thu, 21 Dec 2023 08:32:14 +0000 Subject: [PATCH 2/2] docs: address comments --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e2b01d0..235f9046 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,12 +28,12 @@ feedback for changes that would be required. - Add tests relevant to the fixed bug or new feature. We love to increase our test coverage so any contributions made to improving that will be very welcomed. -## Coding standards +## Coding Standards - This library is modelled after the [GitHub API](https://docs.github.com/en/rest?apiVersion=2022-11-28) and it has been structured to mimic that. - For example, to access the Teams endpoints, you need to instantiate an Organisation Client - and then a Teams Client as [seen here](./src/main/java/com/spotify/github/v3/clients/OrganisationClient.java). This mirrors the nested structure of the API endpoints such as the + For example, to access the Teams endpoints, you need to instantiate an `OrganisationClient` + and then a `TeamsClient` as [seen here](./src/main/java/com/spotify/github/v3/clients/OrganisationClient.java). This mirrors the nested structure of the API endpoints such as the [/orgs/{org}/teams/{team_slug}](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams) endpoint - We operate a monkey see, monkey do approach to this library. We understand that there are some inconsistencies in the library - in terms of how the tests and/or endpoints are written but we, with your help, are working on creating + in terms of how the tests and/or endpoints are written but we, with your help, are working on creating a more consistent codebase. - All bug fixes and new features need to be fully tested. \ No newline at end of file