Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 3.21 KB
Raw

Contributing to Edu Units

Following the lean operating mode contributing to this project has been made as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Submitting a fix
  • Proposing enhancements or domains/topics to be covered
  • Proposing new educational units

Submitting an Issue

Open a GitHub issue to report a bug, propose an enhancement, or suggest a new domain/topic to be covered. Please be very specific in your description and provide a clear title. Also, mark the type of issue you're submitting (bug, enhancement, domain/topic proposal). Please, always consider how any change will impact learning experience of students.

Submitting a Pull Request

Create a GitHub pull request as the best way to propose concrete changes to the website. The steps follow the usual GitHub flow:

  1. Fork the repository and create your branch from main.
  2. If you are proposing a new educational unit, make sure it is self-contained, is original work and has clear learning objectives; take a look at any existing unit how to structure the README file. If your PR is about fixing/improving the website, make sure the changes are consistent with the overall design and the content is accurate. Always test your version locally before making a PR, learn more.
  3. Issue that pull request!

Registering a New Educational Unit

In case your educational unit passes the review, it will be added to the website. The following items are required for a card to be created:

  • Title: The title of the educational unit.
  • Domain: The domain of the educational unit (e.g., Computer Science, Mathematics, Software/Systems Engineering, etc.).
  • Description: A brief description of the educational unit (must fit in two lines on a card).
  • Image: A representative image for the educational unit (must be 410x205 pixels to nicely align with other cards).
  • Link: The link to the repository of the educational unit.

Code of Conduct

Edu Units adheres to a Code of Conduct. By participating, you are expected to uphold this code.

FAQ

What license should be attached to my educational unit?

You are free to choose any open-source license you want, like MIT, Apache, or GPL, to allow for the widest possible use of your work. Any external project without a license will be considered as proprietary and will not be included in this project.

Do I retain full control over my educational unit?

Yes, you retain full control over your educational unit. This project is just a container for linking to your work. You can update, change, or remove your educational unit at any time. Of course, if you decide to delete your repository or make it private, please drop a note so that the matching card is removed, too.

If you have any additional questions, please file an issue of type question.