Looking to contribute something to Operation Code? Here's how you can help.

Please take a moment to review this document in order to make the contribution process seamless and a joy for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:

• Please do not use the issue tracker for personal support requests. Twitter is a better place to get help. If you're already enrolled in Operation Code, we'll often take the conversation into Slack and hammer out the details.

• Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:

• bug - Issues that are reported to us via Twitter or Issues.

• enhancement - Issues that are suggested through Twitter or Slack.

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

0. Validate and lint your code — validate your HTML and lint your HTML to ensure your problem isn't caused by a simple error in your own code.

1. Use the GitHub issue search — check if the issue has already been reported.

2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

3. Isolate the problem — ideally create a reduced test case and a live example. This JS Bin is a helpful template.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

1. This is the first step
2. This is the second step
3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Hound is a bot and part of the core team that hangs out in our GitHub issue tracker and automatically checks for style validation errors during pull requests. If it finds any errors, it will post a follow-up comment on the issue and point out the errors. Think of Hound as your Drill Sergeant. If this happens with a pull request you're submitting, please fix the errors and resubmit. Hound allows the core team to better review and maintain a clean codebase.

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's core team of the merits of this feature. Please provide as much detail and context as possible. Some things to consider:

1. Search Issues for similar feature requests. It's possible somebody has already asked for this feature or provided a pull request that we're still discussing.

2. Provide a clear and detailed explanation of the feature you want and why it's important to add. Keep in mind that we want features that will be useful to veterans learning to code. If we need to create a separate repo, we can do that too.

3. If the feature is complex, consider writing some initial documentation for it. If we do end up accepting the feature it will need to be documented and this will also help us to understand it better ourselves.

Still want to contribute? Carry on.

1. Install latest Ruby
2. Install latest Rails
3. Install PostgreSQL
4. Start PostgreSQL
5. Install Bundler

• Install Homebrew, a package manager for OS X
• Install rbenv, a tool for switching ruby versions

Good pull requests-patches, improvements, new features—are a fantastic help to better tell our story and get more veterans coding. They should remain focused in scope and avoid containing unrelated commits.

Please check with our issues first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the core team might not want to merge into the project.

Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Adhering to the following process is the best way to get your work included in the project. Everyone is encouraged to contribute to the project by forking and submitting a pull request. Steps:

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/operationcode/operationcode.git
   # Navigate to the newly cloned directory
   cd operationcode
   # To setup dependencies
   bundle install
   # To create development and test databases
   bundle exec rake db:setup
   # To start the [server](http://localhost:3000)
   bundle exec rails s
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/operationcode/operationcode.git

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

   git checkout -b <topic-branch-name>

4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream master

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description against the master branch.

When you make a pull request and it's successfully merged, make sure to add your name to the list of contributors in CONTRIBUTORS.md.

Adhere to the Code Guide.

• Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
• Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via file://.
• Use WAI-ARIA attributes in documentation examples to promote accessibility.

Adhere to the Code Guide.

• When feasible, default color palettes should comply with WCAG color contrast guidelines.
• Except in rare cases, don't remove default :focus styles (via e.g. outline: none;) without providing alternative styles. See this A11Y Project post for more details.

• No semicolons (in client-side JS)
• 2 spaces (no tabs)
• strict mode
• "Attractive"

Huge thanks to Twitter Bootstrap whose contributing guide this is based off of.

By contributing your code, you agree to license your contribution under the MIT License. By contributing to the code base, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.