nhcarrigan-private/.profile
1
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Naomi Carrigan
2025-06-12 15:18:19 -07:00
parent 6f9a1ee3ef
commit b939447bcc
1 changed files with 18 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,39 +1,30 @@
# New Repository Template
# NHCarrigan's Code Repositories
This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository.
This website holds all of our source code. This particular organisation contains our private repositories. Most of the work we do is open source, so the code in this organisation is the code covered by non-disclosure agreements with our clients.
If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose.
To preserve the integrity of our organisation, we do NOT grant contributor access to these repositories. However, you are welcome to contribute to our public and game development projects by following the instructions below.
## Readme
## Instance Information
Delete all of the above text (including this line), and uncomment the below text to use our standard readme template.
This Gitea instance is specifically for NHCarrigan's use. This means:
<!-- # Project Name
- To create an account, you must reach out to us [on our forum](https://forum.nhcarrigan.com) so we can grant you an account.
- Once you have an account, you can report issues on our products
- You can NOT create your own repositories and host them on our instance
- You can NOT create your own organisations
Project Description
## Contributor Information
## Live Version
We gladly welcome contributions to our products! However, because our instance does not allow users to create and host their own repositories, you'll need access to create branches on our repositories directly.
This page is currently deployed. [View the live website.]
To obtain this access, please [fill out the form](https://git.nhcarrigan.com/nhcarrigan/.profile/issues/new?template=.gitea%2fissue_template%2fcontributor.yml). Once approved, you'll have access to branch directly on our repositories.
## Feedback and Bugs
Before you start working on code, make sure you've given our [Contributor Guide](https://docs.nhcarrigan.com/dev/contributing/) a read. Additionally, some things you need to follow:
If you have feedback or a bug report, please feel free to open a GitHub issue!
- Branches should be prefixed with your username, e.g. `naomi/feat/add-readme`
- NEVER push to another contributor's branch without their explicit consent
- You will not have access to push directly to `main` - you should ALWAYS create a pull request for our team to review
## Contributing
## Stay Informed
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first.
## Code of Conduct
Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
## License
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
Copyright held by Naomi Carrigan.
## Contact
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`. -->
Make sure you have joined [one of our community platforms](https://chat.nhcarrigan.com)! This is not only a great way to connect with your fellow contributors and stay in the loop on our latest updates, but ensures you can reach us if you have questions or get stuck!