├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Tarides 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 | # hackocaml 2 | 3 | OCaml hacking ideas, small and large. All the useful information is on the [project board](https://github.com/orgs/tarides/projects/32/views/1). This project board contains hacking ideas of various sizes and skill levels. 4 | 5 | ## Adding ideas 6 | 7 | Add a new item in the project board. Make sure to fill in the fields associated with estimated effort. It is not meant to be perfect. Ok to over or underestimate. If you are adding an item that is not already an issue, convert the item to an issue on this (https://github.com/tarides/hackocaml) repo. Add enough details so that someone can get started with just the details in the issue thread. 8 | 9 | Interpret the duration labels as follows: 10 | 11 | ``` 12 | - 1 day => < 1 day 13 | - 1 week => > 1 day && < 1 week 14 | - 1 month => > 1 week && < 1 month 15 | - 1 quarter => > 1 month && < 1 quarter 16 | - 1 year => > 1 quarter && < 1 year 17 | - 1 PhD => > 1 year && open-ended 18 | ``` 19 | 20 | ## Starting to work on an idea listed in the board 21 | 22 | If you are keen to hack on an idea 23 | 24 | 1. If you have write access to the repo, assign the corresponding issue to yourself and start hacking. Otherwise, say so in the issue thread and start hacking. Someone will eventually assign you to the issue. 25 | 2. Update the status to "In Progress". 26 | 27 | Building open-source software is a collaborative activity, and some larger projects will need more than one person's expertise. So, if you see a project that has been assigned to someone but would like also to participate, say so in the thread. It is very likely that there will be room for collaboration on complex projects. 28 | --------------------------------------------------------------------------------