1cfb88c5eb
* Update README.md Remove not actual information regrading the solutions list. Now it's updated automaticaly. * updating DIRECTORY.md * Update README.md add note about automatically updating the `DIRECTORY.md` file * Update leetcode/README.md Co-authored-by: David Leal <halfpacho@gmail.com> * updating DIRECTORY.md --------- Co-authored-by: github-actions[bot] <github-actions@users.noreply.github.com> Co-authored-by: David Leal <halfpacho@gmail.com>
2.6 KiB
📚 Contributing 📚
We're glad you're interested in adding C LeetCode solutions to the repository.
Here we'll be explaining how to contribute to LeetCode solutions properly.
💻 Cloning/setting up the project 💻
First off, you'll need to fork the repository here.
Then, you'll need to clone the repository to your local machine.
git clone https://github.com/your-username/C.git
After that, you'll need to create a new branch for your solution.
git checkout -b solution/your-solution-name
📝 Adding a new solution 📝
All LeetCode problems can be found here.
If you have a solution to any of these problems (which are not being repeated), that's great! Here are the steps:
- Add a new file in
leetcode/srcwith the number of the problem.- For example: if the problem's number is 98, the filename should be
98.c.
- For example: if the problem's number is 98, the filename should be
- Provide a small description of the solution at the top of the file. A function should go below that. For example:
/**
* Return an array of arrays of size *returnSize.
* The sizes of the arrays are returned as *returnColumnSizes array.
* Note: Both returned array and *columnSizes array must be malloced, assume caller calls free().
*/
- Do not provide a
mainfunction. Use the required standalone functions instead. - Doxygen documentation isn't used in LeetCode solutions. Simple/small documentation or comments should be fine.
- Don't include libraries/headers such as
stdio.h. Your file should be the solution to the problem only.
Note
There was a requirement to update the
leetcode/DIRECTORY.mdfile with details of the solved problem. It's not required anymore. The information about the problem is fetched automatically throughout the LeetCode API.
📦 Committing your changes 📦
Once you're done with adding a new LeetCode solution, it's time we make a pull request.
- First, stage your changes.
git add leetcode/src/98.c # Use `git add .` to stage all changes.
- Then, commit your changes.
git commit -m "feat: add LeetCode problem 98" -m "Commit description" # Optional
- Finally, push your changes to your forked repository.
git push origin solution/your-solution-name:solution/your-solution-name
- You're done now! You just have to make a pull request. 🎉
If you need any help, don't hesitate to ask and join our Discord server! 🙂