|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- # Contributing to Homepage
-
- Looking to contribute something to Homepage? **Here's how you can help.**
-
- Please take a moment to review this document in order to make the contribution
- process easy and effective 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.
-
-
- ## Using the issue tracker
-
- The [issue tracker](https://github.com/thetomester13/homepage/issues) is
- the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
- and [submitting pull requests](#pull-requests), but please respect the following
- restrictions:
-
- * Please **do not** derail or troll issues. Keep the discussion on topic and
- respect the opinions of others.
-
- ## Issues and labels
-
- Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
-
- - `bug` - Issues for a potential bug in Homepage.
- - `docs` - Issues for improving or updating our documentation.
- - `feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified.
- - `help wanted` - Issues we need or would love help from the community to resolve.
- - `question` - General purpose question about Homepage.
-
- For a complete look at our labels, see the [project labels page](https://github.com/thetomester13/homepage/labels).
-
-
- ## Bug reports
-
- 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](http://html5.validator.nu)
- and [lint your HTML](https://github.com/twbs/bootlint) 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 live example.
- [This jsfiddle](http://jsfiddle.net/) is a helpful tools.
-
-
- 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).
-
-
- ## Feature requests
-
- 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 developers of the merits of this feature. Please
- provide as much detail and context as possible.
-
-
- ## Pull requests
-
- Good pull requests—patches, improvements, new features—are a fantastic
- help. They should remain focused in scope and avoid containing unrelated
- commits.
-
- **Please ask 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
- project's developers might not want to merge into the project.
-
- Please adhere to the [coding guidelines](#code-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:
-
- 1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
- and configure the remotes:
-
- ```bash
- # Clone your fork of the repo into the current directory
- git clone https://github.com/<your-username>/homepage.git
- # Navigate to the newly cloned directory
- cd homepage
- # Assign the original repo to a remote called "upstream"
- git remote add upstream https://github.com/thetomester13/homepage.git
- ```
-
- 2. If you cloned a while ago, get the latest changes from upstream:
-
- ```bash
- 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:
-
- ```bash
- git checkout -b <topic-branch-name>
- ```
-
- 4. Commit your changes in logical chunks. Please adhere to these [git commit
- message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- or your code is unlikely be merged into the main project. Use Git's
- [interactive rebase](https://help.github.com/articles/about-git-rebase/)
- feature to tidy up your commits before making them public.
-
- 5. Locally merge (or rebase) the upstream development branch into your topic branch:
-
- ```bash
- git pull [--rebase] upstream master
- ```
-
- 6. Push your topic branch up to your fork:
-
- ```bash
- git push origin <topic-branch-name>
- ```
-
- 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
- with a clear title and description against the `master` branch.
-
- **IMPORTANT**: By submitting a patch, you agree to allow the project owners to
- license your work under the terms of the [MIT License](LICENSE.md) (if it
- includes code changes).
-
-
- ## Code guidelines
-
- - Readability
- - Need semicolons
- - strict mode
- - "Attractive"
-
-
- ## License
-
- By contributing your code, you agree to license your contribution under the [MIT License](LICENSE.md).
|