Closed rdbo closed 1 year ago
Hey @rdbo I'd love to work on this :)
Hey @rdbo I'd love to work on this :)
Great @clairecharles! I think the CONTRIBUTING.md
file should have basic step-by-step guide on how to contribute and what to contribute on, in Markdown, of course.
Basically, something like this (you may use this template or change it however you like):
# How to contribute?
You can contribute by:
- Reporting bugs
- Suggesting features/improvemets
- Submitting pull request fixing issues
# How to submit a pull request
- Fork the GitHub repository
- Follow libmem's coding style as much as you can (especially when aligning things)
- Submit a pull request containing a description of what the pull request does, and how it does so
- LEGAL: Every commit submitted through a pull request must be under the same license as libmem (in this case, the GNU AGPLv3.0)
- In case of creating new source code files, make sure to put the following license:
/*
* Copyright (C) <year> <contributor(s)>
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Feel free to add anything you deem important and submit a PR
Contributors should have an easy step-by-step way of learning how to develop libmem. This information should be separated from the API documentation, probably in a
CONTRIBUTING.md
file.