Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 3.26 KB

File metadata and controls

49 lines (28 loc) · 3.26 KB

Contributing to Eugene Code Camp

The Eugene Code Camp website is an open source project, and as such welcomes contributions from the community. Please make sure you read and agree to the Code of Conduct before getting involved.

This site is an ongoing project, currently being built in Vue.js, using Nuxt.js and Boostratp-vue, styled using the Freelancer Theme from Start-Bootstrap.

Getting Started

Please read the README file to learn how to install the project.

The repo tasks are divided into 2 types, projects and one-off issues.

For Contributors with Write Access

If you are a direct contributor, you can make a direct push from a branch to the repo to make a pull request. To do this, go into your local clone and do

$ git checkout -b issue-number

Do the work in this branch and then push it back for your pull request. The git prompts will assist you in this.

For Others

If you do not have direct write access (which is generally only given to those who are regular contributors and/or local attendees), you can fork this repo into your own profile, and then submit a pull request back on the master branch.

For those new to programming

You'll notice some of the issues have the good first issue label. These task are good to learn the basics of using github and making a pull request. If you need help with one of these issues, please make a comment in the issue to request help.

Taking a Task

When selecting a task, start with those that are on the earliest open project or the oldest ones labeled good first issue. (If you don't need the practice or have more experience in programming, please leave the first issues for our beginners.)

If you would like to take an issue, please assign it to yourself. Do not assign yourself more than one issue at a time, as we want others to be able to contribute.

When you are ready to submit your pull request, you will need 2 reviewers OR one admin to approve your request. You can request reviewers or just make the pull request and someone will see it.

Kind Pull Requests

The people approving and merging pull requests are here to help, but you can make it easier on them by making good pull requests. This includes:

  1. Using a clear title for your pull request.
  2. Giving a detailed description of the pull request.
  3. Only including one issue per pull request.
  4. Linking to that issue in your description.
  5. Telling the reviewer, in the description, how this pull request might be tested.

Keep in mind that a pull request is not a guarantee of being merged, and it is also a learning opportunity for others to make comments and suggestions. Whether you are giving or receiving feedback, just remember that we are all learners so please be open-minded and kind!