Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 5.95 KB

CONTRIBUTING.md

File metadata and controls

49 lines (29 loc) · 5.95 KB
Raw

Want to help me on my mission to find the software I can only dream of? Contribute to get started!

Help with contributing

Adding links to software

If you know of existing software for one of my ideas, you can help me by creating a link under an idea so it links to software that is at least the idea I came up with.

Adding to the list is easiest done with the web UI since you don't have to install any software. New? I'll walk you through:

  1. Create a fork. Or, if you already have a fork, sync the "main" branch using the Sync fork option so everything is up to date!
  2. I highly recommend you create a new branch. This just makes it easier to create more changes in the future. When you make your new branch, the files from the "main" branch will automatically copy into it!
  3. Open the list.md file (and make sure you're in your new branch), click the ✏ button, and make your change. On whatever idea that you found software for, replace the link to the issue (should look something like [Found software for this?](https://github.com/DNin01/my-notebook/issues/1)) with a link to the software. This should be styled like [Software available](<url>). Example: [Software available](https://github.com/microsoft/calculator). That's all you need to do.
  4. At the top-right corner, click "Commit changes..." to go to the next step, and click "Commit changes" again to save the file.
  5. Make a pull request to propose the edit.

Done? Congratulations! After I review the software you linked, it'll be referenced in the list, all thanks to you! Plus, I'll have another tool to enjoy.

Tips

  • It's a good idea to check for PRs that link the same software. That way, you know if someone already requested software to be added, and if there happens to be one already, you don't need to make a duplicate PR.
  • Make sure the software is appropriate for the idea and covers all the points I wanted. If I write a note specifically mentioning a graphing feature for a calculator app, then I'm not asking for a calculator without a graphing mode. However, if I say that maybe a graphing mode would be cool, it's okay if you can't find a calculator app with that feature.
  • Only add one link per PR. If I have to add a bunch of software at once, they'll all have to be reviewed, which would prolong the review time for your PR. Plus, if one software link is rejected, the entire PR may have to be rejected until you make a change. You can always make multiple PRs each with a single change.
  • I'd like if the software you're telling me about has a repository on GitHub and you link to it, even if there is an official website. That way, the software references don't go off-site. If you can't find a GitHub repository or the software is closed-source, link to the official software homepage or preferably to a store page, and please indicate that with the following: [Software available on <store/website name>](<store/home page url>). Example: [Software available on Microsoft Store](https://www.microsoft.com/store/apps/9WZDNCRFHVN5)
  • Be patient - your PR won't be merged right away (in other words, your changes won't be applied to the base repository immediately), and depending on the complexity of the software and how many other PRs are coming in, it might take a lot of time to review. Just hang in there while it's checked for quality and safety. Also, at the moment, I'm the only maintainer. I want to collaborate eventually, but I'll try my best to ensure the quality and safety of the software that's linked.

It's also okay to request to change the links to software occasionally. You might want to do this if there is software with more of the might-be-cool features I've mentioned, or it's more powerful while still being about as intuitive.

Making other changes

Feel free to propose changes to some of the general repository files (like the contributing guidelines, in case of a typo) or anything else!

(If you missed it, the steps to make a pull request are above)

Error corrections (like fixes to any typos or incorrect information) are welcome, but I do recommend you keep in mind the list format and the fact that I'm writing the notes. I can't always change everything in the repository without it causing conflicts on pending PRs, so depending on the change I make, it might not work out. And this particular list is meant to be my collection of ideas, not a community curation. But... for anyone who wants to make their own lists, it might be worth checking out or making an awesome list.

Submitting issues

If you don't feel like going through the process of creating a pull request, you can always use issues to send feedback and suggestions for other repository files.

You can also mention software you found by commenting on the issue asking for it (for instance, if I noted down some ideas for a particular kind of app and I don't know of any apps that do the same things, you can write a comment and mention an app with the feature ideas I wrote down). I'll be happy to add it to the list for you.

Still need help?

Feel free to ask questions by leaving a help/support request in Discussions.

Credits

Thanks to everyone who has contributed and sent feedback!