Add CONTRIBUTING.md - Githubissues

rexagod commented 5 years ago

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

[ ] 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!
[ ] 📝 Update: Add a CONTRIBUTING.md file to this repository by including all the content mentioned below and submitting a PR to us with the same. You can also check out an existing CONTRIBUTING.md here for reference purposes.

Contributing to inline-markdown-editor
==========================

We welcome community contributions to inline-markdown-editor! To install inline-markdown-editor locally, follow the instructions in the [README.md file](https://github.com/publiclab/inline-markdown-editor#contributing).

We especially welcome contributions from people from groups underrepresented in free and open source software!

Our community aspires to be a respectful place. Please read and abide by our [Code of Conduct](https://publiclab.org/conduct).

## First Timers Welcome!

New to open source/free software? See our WELCOME PAGE, including a selection of issues we've made especially for first-timers. We're here to help, so just ask if one looks interesting:

https://code.publiclab.org/#r=all

Thank you so much!

Learn more about contributing to Public Lab code projects on these pages:

* https://publiclab.org/developers
* https://publiclab.org/contributing-to-public-lab-software
* https://publiclab.org/soc
* https://publiclab.org/wiki/developers
* https://publiclab.org/wiki/gsoc-ideas

## Bug reports & troubleshooting

If you are submitting a bug, please go to https://github.com/publiclab/inline-markdown-editor/issues/new

[ ] 💾 Commit your changes
[ ] 🔀 Start a Pull Request. There are two ways how you can start a pull request:

If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.
You can also edit files directly in your browser and open a pull request from there.

[ ] 🏁 Done Ask in comments for a review :)

🤔❓ Questions?

Is someone else already working on this?

We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. If someone seem stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

borzois commented 5 years ago

Thanks for making this! I'm going to do this one now

borzois commented 5 years ago

I made the pull request at #41. Did I do it correctly?

publiclab / inline-markdown-editor

Add CONTRIBUTING.md #39

🤔 What you will need to know.

📋 Step by Step

🤔❓ Questions?

Is someone else already working on this?