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!
Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
[ ] ๐ 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 the file README.md in the plots2 repository (press the little pen Icon) and edit the line as shown below.
See this page for some help in taking your first steps!
Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:
@@ -104,8 +104,8 @@ For installation, prerequisites include sqlite3 and rvm. [Click here for a compl
* Install gems with `bundle install --without production mysql` from the rails root folder, to install the gems you'll need, excluding those needed only in production.
6. Run `cp db/schema.rb.example db/schema.rb` to make a copy of `db/schema.rb.example` in `db/schema.rb`.
7. You could choose to use mysql2 or sqlite3 as your database
- * If mysql2 Run `cp config/database.yml.mysql.example config/database.yml` to make a copy of `config/database.yml.mysql.example` in `config/database.yml`
- * If sqlite3, Run `cp config/database.yml.sqlite.example config/database.yml` to make a copy of `config/database.yml.sqlite.example` in `config/database.yml`.
+ * If mysql2, run `cp config/database.yml.mysql.example config/database.yml` to make a copy of `config/database.yml.mysql.example` in `config/database.yml`.
+ * If sqlite3, run `cp config/database.yml.sqlite.example config/database.yml` to make a copy of `config/database.yml.sqlite.example` in `config/database.yml`.
_kindly note if you choose to use sqlite some tests may fail. The project was setup initially to use mysql and some tests are tailored for mysql db. No need for alarm, we are working to fix these and this will not interfere with your development process_
8. Run `rake db:setup` to set up the database
9. Install static assets (like external javascript libraries, fonts) with `yarn install`
[ ] ๐พ Commit your changes
[ ] ๐ Start a Pull Request. There are two ways how you can start a pull request:
๐ฌโฐ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!
If this happens to you, don't sweat it! Grab another open issue.
๐- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.
๐ฅ- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!
Leave a comment below!
Hello, I am interested in getting involved in open source and have not contributed to a project before, could I claim this?
Edit: I'd like to let you know that I am not from an underrepresented community and I understand this is an important consideration for the owners of this project. Still eager to help nonetheless!
Hey @slaterp it's completely chill. You can go ahead and contribute to this.
Cheers!
Can I make any contributions to this?
Hi, can I make any contributions to this ticket, please? I am first timer as well.
Hi @taylorrobertss and @pratheekcr it looks like this particular issue was merged by @slaterp.
There may be more grammar fixes that need to be done in README.md, I recommend you take a look and make a new issue if you see anything!
You can also see issues that are reserved for first-timers here. There are also some first-timer issues that haven't yet been formatted into our template yet here (it just takes a little more browsing).
Let us know on this page, or in our chatroom if you'd like some help navigating any of this ๐
@coder645 polite reminder to kindly refrain from using gender identifying names unless you know the preferred pronouns of the contributor so that we can keep being welcoming and respectful...I've edited your comment a bit ...Thanks a lot for all the amazing work you are doing, highly appreciated :heart:.