Skip to content

Commit bf4c39d

Browse files
committed
add gitlab-ci and contrib
1 parent 153f194 commit bf4c39d

File tree

3 files changed

+65
-13
lines changed

3 files changed

+65
-13
lines changed

.gitlab-ci.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
image: python:3.5
2+
3+
4+
test:
5+
script:
6+
- python tests.py
7+
when: on_success

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
### Hello!
2+
3+
If you're reading this, you'd like to contribute to one of my open source projects! Contributions are welcome and encouraged on this and any other of my projects.
4+
5+
6+
### General Resources
7+
8+
* **[Coderouge (GitLab)](https://git.coderouge.co)** is the primary destination for this project's source code repository, issue tracker, contribution management (pull requests) and testing infrastructure / CI.
9+
* If you're reading this on **GitHub**: this is kept as a mirror of the main repo that is hosted on the aforementioned GitLab instance. If you have quick contributions to make in the way of issues or pull requests, then feel free to do so here and I will migrate them back to the main repo. If you would like to be more involved in this project, however, I'd invite you to work from the GitLab instance - it's faster, snazzier and more directly connected to testing infrastructure.
10+
* Documentation for development is kept in `README.md`, changelogs in `CHANGELOG`.
11+
12+
13+
### Submitting Pull Requests
14+
15+
Pull requests are a great way to add a new feature for yourself to use, and to help others who might be using this project along the way. Please follow the style guide below for your code submissions, and don't forget to adequately test your code before you make the request. I'll get to it as soon as I can, and review it with you if need be.
16+
17+
18+
### Filing Bugs
19+
20+
If you come across a bug in this project, your bug reports are welcome! Take a look at the issue tracker first to make sure the bug hasn't already been reported. If you end up filing a duplicate, don't worry - better to have an over-reported bug then one that goes unnoticed!
21+
22+
The best bug reports are short but clear. There's a certain amount of critical information needed in order to successfully solve the problem. Please try to make sure your bug report touches on the following:
23+
24+
* Context: information on the issue encountered
25+
* Process: an ordered list of the steps I can take to reproduce the issue
26+
* Expected result: the result you expect to happen when you follow the above steps
27+
* Actual result: the thing that happens (that is not supposed to happen) when you follow the above steps
28+
* Any suggested fixes, stack traces or supporting documentation that would be helpful. If you are running a GUI-based application, screenshots are also good to include.
29+
30+
31+
### Requesting Improvements
32+
33+
If you have suggestions regarding how this project can be improved, but are not able to submit a pull request to achieve it yourself, feel free to file an issue with "Suggestion" somewhere in the title. It doesn't have to follow the bullet points for bugs given above, but should include detailed information about your use case, and most importantly why this suggestion would be good for anyone else who would like to use this project.
34+
35+
36+
### Style Guide
37+
38+
A few things to remember when contributing code:
39+
40+
* Commit messages should accurately enough describe the problem.
41+
* Be sure to adequately comment lengthy contributions.
42+
* Python code should use four spaces for each indent, instead of a tab.
43+
* Python code should follow [PEP8](https://www.python.org/dev/peps/pep-0008/) whenever feasible. I recommend using [flake8](http://flake8.pycqa.org/en/latest/).
44+
* Python code should support Python 3 by default. (If this is a Python 2.x-only repo or branch, disregard)
45+
* JavaScript code should support [JavaScript Standard Style](http://standardjs.com).
46+
47+
48+
### Conduct
49+
50+
I try to use all of my projects as an example of what positive and respectful effort can achieve in open source. I invite you to do the same as you contemplate contributing to this project. Feel free to offer constructive criticism when you feel its necessary, but refrain from being unnecessarily harsh, making any sort of personal attack or using inappropriate language. I have zero tolerance for harassment of any kind.
51+
52+
53+
### Asking for Help
54+
55+
If you'd like to ask questions about contributing to this project or about the code contained within, feel free! My profile page on GitHub/GitLab will have links to my Twitter account or my email, I will respond whenever possible.
56+
57+
58+
# Thank you!

test.py

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)