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 README/contributing guide #33

Open
nickebbitt opened this issue Nov 30, 2021 · 7 comments
Open

Add README/contributing guide #33

nickebbitt opened this issue Nov 30, 2021 · 7 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@nickebbitt
Copy link
Collaborator

nickebbitt commented Nov 30, 2021

We need a simple README and instructions for building and running locally, as well contributing

@nickebbitt nickebbitt added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Nov 30, 2021
@Daveu1983
Copy link
Contributor

ReadMe added at d19ab04

Will look to add contributing guide.

@Daveu1983 Daveu1983 self-assigned this Sep 28, 2022
@Daveu1983
Copy link
Contributor

Daveu1983 commented Sep 28, 2022

Contributing guide should include similar code of conduct detailed at https://jmanc.org/code-of-conduct

@Daveu1983
Copy link
Contributor

Prior to contributing guide, setting up some standard repo rules. Created a team to review PR's - Organisers. Invited @nickebbitt @jonbullock and @CraigMcDonaldCodes to the team

@Daveu1983
Copy link
Contributor

Added branch protection rule to main, only organisers can push direct, pull requests will require review. Code Owners will need to review once code owners file pushed to repo (will add the to contributing guide md). Organisers can dismiss PR rules. No force commits and branch cannot be deleted.

@Daveu1983
Copy link
Contributor

#66 for the contributing guide.

@nickebbitt
Copy link
Collaborator Author

Merge, cheers Dave 👍

@craig-mcd
Copy link
Contributor

I've got #73 for another doc update, not sure if it totally covers all use cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants