Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer guide page #114

Merged
merged 5 commits into from
Apr 10, 2024
Merged

Add developer guide page #114

merged 5 commits into from
Apr 10, 2024

Conversation

jatkinson1000
Copy link
Member

@jatkinson1000 jatkinson1000 commented Apr 8, 2024

This will close #106

Adds guidance for developers:

  • GitHub issues, forks, and PRs
  • Using the hook
  • fypp
  • How to extend the API
  • Documentation (FORD, and what to add)

@jatkinson1000 jatkinson1000 added the documentation Improvements or additions to documentation label Apr 8, 2024
@jatkinson1000 jatkinson1000 self-assigned this Apr 8, 2024
@jatkinson1000 jatkinson1000 marked this pull request as ready for review April 9, 2024 01:01
@jatkinson1000
Copy link
Member Author

Hi All, think this is ready for review.
@ElliottKasoar in particular let me know how it looks in response to #106

Copy link
Contributor

@jwallwork23 jwallwork23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! A few suggested edits and additions.

README.md Show resolved Hide resolved
pages/developer.md Outdated Show resolved Hide resolved
pages/developer.md Outdated Show resolved Hide resolved
pages/developer.md Outdated Show resolved Hide resolved
pages/developer.md Show resolved Hide resolved
pages/developer.md Outdated Show resolved Hide resolved
Copy link
Member

@TomMelt TomMelt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had some suggestions. They are all optional.

Thanks Jack 👍

pages/developer.md Show resolved Hide resolved
pages/developer.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ElliottKasoar ElliottKasoar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks @jatkinson1000! This more than addresses the issue I raised, which is good approach since if we'd just added a starting point for documentation there'd be less motivation.

I think the link in the README is the only thing that needs checking, although I think I agree with all of the comments too.

Copy link
Contributor

@jwallwork23 jwallwork23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes @jatkinson1000.

@jatkinson1000
Copy link
Member Author

@ElliottKasoar If you are happy and can remove your request changes I'll get this squashed and merged.

Copy link
Contributor

@ElliottKasoar ElliottKasoar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again!

@jatkinson1000 jatkinson1000 merged commit 4b70f2f into main Apr 10, 2024
4 checks passed
@jatkinson1000 jatkinson1000 deleted the developer-guide branch April 10, 2024 10:07
dorchard pushed a commit that referenced this pull request Nov 15, 2024
* Add developer guide page

* Update README with link to developer docs.

* Update developer pages following review from JW, EK, and TM.

* Update developer pages to use jwa34 personal email as a contact point rather than ICCS admin.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add developer guide
4 participants