├── .gitignore └── .gitignore ├── template ├── LICENSE.md ├── CODE_OF_CONDUCT.md └── README.md └── README.md /.gitignore/.gitignore: -------------------------------------------------------------------------------- 1 | # 2 | -------------------------------------------------------------------------------- /template/LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 UCSD ECE Undergraduate Student Council 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Project Template 2 | 3 | A template for all ECE USC Open Source project repos! 4 | 5 | 6 | ## What is this? 7 | 8 | In our GitHub organization, [@eceusc](https://github.com/eceusc), we have a lot of repositories. Only a few of these repos are "project" repositories, meant specifically for an ECE USC Open Source Project (which are prefixed with `project-`). We want to standardize a few things about these project repositories (e.g., `README` structure, `LICENSE`, `CODE_OF_CONDUCT`, etc. So, this repo has a tool to do just that! 9 | 10 | 11 | ## Usage 12 | 13 | Everything you need is inside the `/template` directory - this includes: 14 | 15 | ### `README.md` 16 | 17 | This is a simple skeleton of suggestions of what to put in your repository. Most of the sections are straightforward - `About`, `Getting Started`, `Quick Demo`, `Prerequisites`, etc. 18 | 19 | ### `CODE_OF_CONDUCT.md` 20 | 21 | This Code of Conduct is an adaptations of the [Contributor Covenant](https://www.contributor-covenant.org/), with the [UC San Diego Principles of Community](https://ucsd.edu/about/principles.html) included as well. 22 | 23 | ### `LICENSE.md` 24 | 25 | As of now, just a simple MIT license. 26 | 27 | ## Adding to your repo 28 | 29 | To add these templates to your repo, on mac/linux use: 30 | 31 | ``` bash 32 | wget https://raw.githubusercontent.com/eceusc/project-template/master/README.md 33 | wget https://raw.githubusercontent.com/eceusc/project-template/master/CODE_OF_CONDUCT.md 34 | wget https://raw.githubusercontent.com/eceusc/project-template/master/LICENSE.md 35 | ``` 36 | 37 | Or, click these links for a direct download to your repo: 38 | - [`README.md`](https://raw.githubusercontent.com/eceusc/project-template/master/README.md) 39 | - [`CODE_OF_CONDUCT.md`](https://raw.githubusercontent.com/eceusc/project-template/master/CODE_OF_CONDUCT.md) 40 | - [`README.md`](https://raw.githubusercontent.com/eceusc/project-template/master/LICENSE.md) 41 | -------------------------------------------------------------------------------- /template/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## UC San Diego Principles of Community 4 | 5 | As a student-ran organization within UC San Diego, all work done in the name of 6 | an Open Source project should be done with the 7 | [UC San Diego Principles of Community](https://ucsd.edu/about/principles.html) 8 | in mind. Failure to do so will result in the enforcement of this code described below. 9 | 10 | ## Our Pledge 11 | 12 | In the interest of fostering an open and welcoming environment, we as 13 | contributors and maintainers pledge to making participation in our project and 14 | our community a harassment-free experience for everyone, regardless of age, body 15 | size, disability, ethnicity, sex characteristics, gender identity and expression, 16 | level of experience, education, socio-economic status, nationality, personal 17 | appearance, race, religion, or sexual identity and orientation. 18 | 19 | ## Our Standards 20 | 21 | Examples of behavior that contributes to creating a positive environment 22 | include: 23 | 24 | * Using welcoming and inclusive language 25 | * Being respectful of differing viewpoints and experiences 26 | * Gracefully accepting constructive criticism 27 | * Focusing on what is best for the community 28 | * Showing empathy towards other community members 29 | 30 | Examples of unacceptable behavior by participants include: 31 | 32 | * The use of sexualized language or imagery and unwelcome sexual attention or 33 | advances 34 | * Trolling, insulting/derogatory comments, and personal or political attacks 35 | * Public or private harassment 36 | * Publishing others' private information, such as a physical or electronic 37 | address, without explicit permission 38 | * Other conduct which could reasonably be considered inappropriate in a 39 | professional setting 40 | 41 | ## Our Responsibilities 42 | 43 | Project maintainers are responsible for clarifying the standards of acceptable 44 | behavior and are expected to take appropriate and fair corrective action in 45 | response to any instances of unacceptable behavior. 46 | 47 | Project maintainers have the right and responsibility to remove, edit, or 48 | reject comments, commits, code, wiki edits, issues, and other contributions 49 | that are not aligned to this Code of Conduct, or to ban temporarily or 50 | permanently any contributor for other behaviors that they deem inappropriate, 51 | threatening, offensive, or harmful. 52 | 53 | ## Scope 54 | 55 | This Code of Conduct applies both within project spaces and in public spaces 56 | when an individual is representing the project or its community. Examples of 57 | representing a project or community include using an official project e-mail 58 | address, posting via an official social media account, or acting as an appointed 59 | representative at an online or offline event. Representation of a project may be 60 | further defined and clarified by project maintainers. 61 | 62 | ## Enforcement 63 | 64 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 65 | reported by contacting the project team at eceusc+opensource@eng.ucsd.edu. All 66 | complaints will be reviewed and investigated and will result in a response that 67 | is deemed necessary and appropriate to the circumstances. The project team is 68 | obligated to maintain confidentiality with regard to the reporter of an incident. 69 | Further details of specific enforcement policies may be posted separately. 70 | 71 | Project maintainers who do not follow or enforce the Code of Conduct in good 72 | faith may face temporary or permanent repercussions as determined by other 73 | members of the project's leadership. 74 | 75 | ## Attribution 76 | 77 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 78 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 79 | 80 | [homepage]: https://www.contributor-covenant.org 81 | -------------------------------------------------------------------------------- /template/README.md: -------------------------------------------------------------------------------- 1 | # Project Example Name ![](https://img.shields.io/badge/slack-%23project--vending--machine-%234d394b.svg?style=flat&logo=slack&link=https%3A%2F%2Feceopensource.slack.com%2Fmessages%2FCF90BHRAM) 2 | 3 | A quick one line explanation of what the project does, with emoji! :notebook_with_decorative_cover: 4 | 5 | \ 6 | 7 | \ 8 | 9 | ## About 10 | 11 | This paragraph (1-2 sentences) is a high-level non-technical overview of what the project is meant to do. 12 | 13 | This paragraph (1-2 sentences) is a more technical overview of how the project works (devices, programming languages, tools, hosting services, etc.). 14 | 15 | ## Getting Started 16 | 17 | This section is a short, technical tutorial on how to clone, setup, and run the project. 18 | 19 | ### Quick Demo 20 | 21 | If possible, have a "Deploy to Heroku", "Edit with Glitch" button. 22 | 23 | 24 | ### Prerequisites 25 | 26 | If someone wants to run this project, do they need to install thing? This can be a quick 1 sentence saying something like "To run this project, make sure that:" followed by a numbered list like 27 | 28 | 1. Have [Python3 installed](https://www.python.org/downloads/) 29 | 2. Have [Pip installed](https://pip.pypa.io/en/stable/installing/) 30 | 3. Have a [Glitch account](https://www.glitch.com) 31 | 32 | \ 33 | 34 | ### Installing 35 | 36 | Quick 1-2 sentences saying where to run these commands (terminal, git bash on Windows, etc.) 37 | 38 | ```shell 39 | 40 | git clone https://github.com/eceusc/project-example.git 41 | cd project-example 42 | # set up commands, install dependencies, etc 43 | python3 main.py 44 | ``` 45 | 46 | Then, 1 sentence to show what they should see after running the above: 47 | 48 | ```shell 49 | $ python3 main.py 50 | Example server running on port 3000! 51 | ``` 52 | 53 | \ 54 | 55 | 56 | ### Troubleshooting 57 | (bc they probably will have trouble running the above) 58 | 59 | Something like "If you have trouble install the above, try:" 60 | 61 | 1. Make sure python is installed correctly 62 | 2. Make sure pip is installed 63 | 3. If \, try: doing X or Y 64 | 65 | "If you still can't figure it out, join the [ECE USC Open Source Slack](https://join.slack.com/t/eceopensource/shared_invite/enQtNTI3NjE5MzczMjY1LWQ2YTE3ZmEzODcyM2JlOTM2M2RkMDM5MzEwYTdlYTQ1MWM5MmFjNTQ5MTI5MTI1YjA1NTNhNTk2YjA1YTllMzU) and ask for help in our [#help](https://eceopensource.slack.com/messages/CDCH9HTFW) slack channel! 66 | 67 | ## Contributing 68 | 69 | 70 | 71 | If you would like to contribute, follow these steps: 72 | 73 | 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository 74 | 2. On your forked repository, create a branch for your specific feature/fix (`git checkout -b my-contribution`) 75 | 3. Commit your changes, push it to your repo (`git commit -m "message describing your changes"`, `git push origin master`) 76 | 4. On GitHub, send a pull request to this repository! 77 | 78 | Also, take a look at the Issues tab above to see what needs help. Also keep in mind our Code of Conduct while you make your contributions :) 79 | --------------------------------------------------------------------------------