This repository is the home for all Scout open source projects. Dotfiles, contributors guides, and Scout's latest Code of Conduct can all be found here.
Every open source project at Scout should start by cloning this project. This will ensure all Scout projects have the same starting point as far as code style, code of conduct, contribution guides, and npm scripts.
This file also serves as a template for every project's README. New sections can be added as necessary in between API and Maintainers, but everything here (except Background) should be kept. This will ensure all Scout projects are easy to pick up and use, and that documentation is both present and clear. Everything in this document before the Code of Conduct section should be updated. Everything after those can stay the same :)
Any time you change this repo, you should PR all other repos with the changes. This ensures that all projects have the latest version of this project.
When creating a new project, make sure to:
- Find and replace all instances of
open-sourcewith the new project name. - Replace the contents of the Code of Conduct with a link to the official CoC in this repository.
- Update the projects' maintainers if the Tech Director isn't maintaining the project
Some background information on the project. This section isn't necessary for many projects, but might be nice to have if you want it?
How to npm install or if it requires extra setup steps. If it requires changes to configs or package.json or anything that can all go here.
How to use the thing. This should include (as applicable) instructions and examples for ESModules, CJS modules, UMD builds, script tags, etc.
A full API doc. This can either be embedded in the README if it's short enough, otherwise extract it to a separate markdown doc and link to the doc.
Email: amarkon895@gmail.com
Twitter: @amarkon88
Scout strives to provide a welcoming, inclusive environment for all users, period. To hold ourselves accountable to that mission, Scout has a strictly-enforced code of conduct. Violating those rules will result in removal from the Scout organization, and potentially being banned from contributing to our projects.
We welcome all contributions to our projects! Filing bugs, feature requests, code changes, docs changes, or anything else you'd like to contribute are all more than welcome! More information about contributing to Scout projects can be found in our contributors' guide!
All Scout libraries are ISC-licensed. tl;dr: you can use this code however you'd like, just please attribute us appropriately!
Scout is Northeastern University's student-led design studio. The Studio has about 45 members selected via interview and application processes to select the university's best talent. Each semester the studio produces design and development assets for four ventures. Check out our portfolio for some past projects!