Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 2.57 KB
Raw

Licensing

The lobsters codebase is under a 3-clause BSD license. All code submitted must be licensed under these or more-permissive terms (2-clause BSD, MIT, ISC, etc.).

Before Making Changes

If you're new to contributing, issues tagged good first issue require little knowledge of the codebase or community. Please don't hesitate to ask questions in the issue or in our chat room, we'd love to help you get involved.

You can jump right in to issues tagged good first issue, you don't have to ask permission. Please don't post a comment asking because if you don't finish, the comment confuses a potential contributor who might not pick it up.

While this project's license allows for modification and use to run your own website, this source code repository is for the code running the website at lobste.rs.

Not all changes or new features submitted will be accepted. Please discuss your proposed changes on /t/meta or as a Github issue before working on them to avoid wasted efforts.

Making Changes

  • Fork lobsters/lobsters on Github.

  • (Optional) Create a branch to house your changes.

  • Run bundle exec standardrb to check the style of your Ruby. No messages means success. Adding --fix will take care of most issues automatically, and there's excellent editor integration available. (3rd party, externally-maintained code such as Javascript libraries can remain in their own style.)

  • Check for unnecessary whitespace with git diff --check before committing. Commit whitespace and other code cleanups separately so that your actual changes can be easily understood.

  • Write a proper commit message with the first line being a short, present-tense explanation of the change. Wrap message lines at 80 characters.

  • If applicable, add tests for your changes. Not all changes require tests, and tests should not be added just for the sake of code coverage.

  • Run all tests (with bundle exec rspec in the root directory) to ensure nothing has been broken by your changes.

Submitting Changes

  • Push your changes to your fork of the repository (to your branch if you created one).

  • Submit a pull request to lobsters/lobsters.