Welcome to the dev.to codebase. We are so excited to have you. With your help, we can build out DEV to be more stable and better serve our community.
Table of Contents
- Getting Started
- Additional docs
- Product Roadmap
- Core Team Members
We expect contributors to abide by our underlying code of conduct. All conversations and discussions on GitHub (issues, pull requests) and across dev.to must be respectful and harassment-free.
Where to contribute
Refactoring code, e.g. improving the code without modifying the behavior is an area that can probably be done based on intuition and may not require much communication to be merged.
Fixing bugs may also not require a lot of communication, but the more the better. Please surround bug fixes with ample tests. Bugs are magnets for other bugs. Write tests near bugs!
Building features is the area which will require the most communication and/or negotiation. Every feature is subjective and open for debate. The product roadmap should be a good guide to follow. As always, when in doubt, ask!
How to contribute
- Fork the project & clone locally. Follow the initial setup here.
- Create a branch, naming it either a feature or bug:
git checkout -b feature/that-new-featureor
- Code and commit your changes. Bonus points if you write a good commit message:
git commit -m 'Add some feature'
- Push to the branch:
git push origin feature/that-new-feature
- Create a pull request for your branch
Create an issue
Nobody's perfect. Something doesn't work? or could be done better? Let us know by creating an issue.
PS: a clear and detailed issue gets lots of love, all you have to do is follow the issue template!
Clean code with tests
Some existing code may be poorly written or untested, so we must have more scrutiny going forward. We test with rspec, let us know if you have any questions about this!
Create a pull request
- Try to keep the pull requests small; a pull request should try its very best to address only a single concern.
- Make sure all tests pass and add additional tests for the code you submit.
- Document your reasoning behind the changes. Explain why you wrote the code in the way you did; the code should explain what it does.
- If there's an existing issue related to the pull request, reference to it by adding something like
References/Closes/Fixes/Resolves #305, where 305 is the issue number. More info here
- If you follow the pull request template, you can't go wrong.
Please note: all commits in a pull request will be squashed when merged, but when your PR is approved and passes our CI, it will be live on production!
How to get help
Whether you are stuck with feature implementation, first-time setup, or you just want to tell us something could be done better, check out our OSS thread or create an issue. You can also mention any core team member in an issue and we'll respond as soon as possible.
The bottom line
We are all humans trying to work together to improve the community. Always be kind and appreciate the need for tradeoffs.
Additional technologies and services are listed on our docs.
This project follows Thoughtbot's Ruby Style Guide, using Rubocop along with Rubocop-Rspec as the code analyzer. If you have Rubocop installed with your text editor of choice, you should be up and running.
When commits are made, a git precommit hook runs via husky and lint-staged. ESLint, prettier, and Rubocop will run on your code before it's committed. If there are linting errors that can't be automatically fixed, the commit will not happen. You will need to fix the issue manually then attempt to commit again.
Note: if you've already installed the husky package at least once (used for precommit npm script), you will need to run
yarn --force or
npm install --no-cache. For some reason, the post-install script of husky does not run when the package is pulled from yarn or npm's cache. This is not husky specific, but rather a cached package issue.
These pre-requisites assume you are running macOS. If you are running a different OS, you should install these pre-requisites specific to your OS.
- Ruby: we recommend using rbenv to install the Ruby version listed on the badge.
gem install bundler
gem install foreman
- Yarn: use
brew install yarnto install yarn. It will also install node if you don't already have it.
- PostgreSQL: the easiest way to get started with this is to use Postgres.app.
git clone firstname.lastname@example.org:thepracticaldev/dev.to.git
- Set up your environment variables/secrets
- Take a look at
Envfile. This file lists all the
ENVvariables we use and provides a fake default for any missing keys. You'll need to get your own free Algolia credentials to get your development environment running.
- This guide will show you how to get free API keys for additional servies that may be required to run certain parts of the app.
- For any key that you wish to enter/replace:
config/application.ymlby copying from the provided template (
cp config/sample_application.yml config/application.yml). This is a personal file that is ignored in git.
- Obtain the development variable and apply the key you wish to enter/replace. ie:
GITHUB_KEY: "afaslkjdflkj2398jflskdjfljk" GITHUB_SECRET: "23r8dcvlk23jekljfslkdfjlks"
- If you are missing
ENVvariables on bootup,
enviedgem will alert you with messages similar to
'error_on_missing_variables!': The following environment variables should be set: A_MISSING_KEY..
- You do not need "real" keys for basic development. Some features require certain keys, so you may be able to add them as you go.
- Take a look at
Starting the application
We're mostly a Rails app, with a bit of Webpack sprinkled in. For most cases, simply running
bin/rails server will do. If you're working with Webpack though, you'll need to run the following:
bin/startupto start the server, Webpack, and our job runner
foreman start -f Procfile.devunder the hood.
alias start="bin/startup"makes this even faster.
- If you're using
pryfor debugging in Rails, note that using
prytogether works, but it's not as clean as
Here are some singleton commands you may need, usually in a separate instance/tab of your shell.
- Running the job server (if using
bin/rails server) -- this is mostly for notifications and emails:
- Clearing jobs (in case you don't want to wait for the backlog of jobs):
Current gotchas: potential environment issues with external services need to be worked out.
We use Spring and it is already included in the project.
- Use the provided bin stubs to automatically start Spring, i.e.
- If Spring isn't picking up on new changes, use
spring stop. For example, Spring should always be restarted if there's a change in environment key.
- Check Spring's status whenever with
bin/rspec is not equipped with Spring because it affects Simplecov's result. Instead use
Our new product roadmap can be found here. Many notes need to be converted to issues but this should provide an overview of features we plan to work on, as well as features we are considering.
Core team members will move issues along the project board as they progress.
- Ideas & Requests: features up for discussion.
- Needs Owners: features in need of an owner.
- Committed: features we're committed to building -- free for contributors to work on, but please communicate with the owner beforehand.
- In Progress (early stage): work has begun on feature.
- In Progress (late stage): feature is near completion.
DEV is licensed under the GNU Affero General Public License 3 (AGPL-3). Please see the LICENSE file in our repository for the full text.
Like many open source projects, we require that contributors provide us with a Contributor License Agreement (CLA). By submitting code to the DEV project, you are granting us a right to use that code under the terms of the CLA.
Our version of the CLA was adapted from the Microsoft Contributor License Agreement, which they generously made available to the public domain under Creative Commons CC0 1.0 Universal.