Skip to content

Commit

Permalink
📝 More relevant for ct.js, better contribution guides and templates
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmoMyzrailGorynych committed Aug 15, 2019
1 parent 0556f38 commit b2c52ec
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 16 deletions.
11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@ A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
2. Click on '...'
3. ...
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
**Screenshots (recommended)**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
**Example project (strongly recommended)**
Upload a minimal zipped project that showcases the bug.

**Versions:**
- OS: [e.g. Windows 10]
- ct.js version [see at the bottom of the starting screen]
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Is your feature request related to a problem?**
Describe your pain! Ex. I'm always frustrated when my copies explode [...]
Tag any related issues here.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
Your vision of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
Expand Down
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,28 @@ ct.js consists of several modules and repos, so make sure you post to a correct

* If you found an error in docs, or would like to add a new tutorial, doc piece, or other improvements to docs.ctjs.rocks, then open an issue in [this repo](https://github.com/ct-js/docs.ctjs.rocks) instead.
* Similarly, if you want to contribute to the website ctjs.rocks, visit [this repository](https://github.com/ct-js/ct-js-site).
* If you have a question about programming games in ct.js, or have general questions, it is better to ask it on our [Discord server](https://discord.gg/CggbPkb), as you are more likely to get answers there faster. It also keeps our roadmap clean.
* If you have a question about programming games in ct.js, or have general questions, it is better to ask it on our [Discord server](https://discord.gg/CggbPkb), as you are more likely to get answers there faster

## Submitting an issue

Please select an appropriate template for an issue. Screenshots and reproduction steps will help us fix bugs quicker, so do take some pretty shots of… error messages :D A sample project will come in handy as well.

## Contributing by code

### Vision and general guidelines

ct.js aims to make learning programming fun and game development easy. In practice, it all breaks down into good pipelines, smooth workflow, high-quality docs, approachability of the engine, and a healthy community. So,

* If you are adding changes that make the workflow more complicated without any visible advantage, you are doing something wrong.
* New API or functionality that has no docs is **non-existent for users**. Do write docs. Tutorials and example projects are also cool.
* If possible, write tests. Until we don't come up with a better solution, write test projects in ct.js.

Make sure you comply to style guides — a uniform style is one of the necessities for a maintainable project! Use `gulp lint` to highlight code style issues locally.

Make your commits reasonably atomic, so you don't fix two or more bugs in one commit and such, so they can be reviewed easily and merged to the main branch quickly. They can also be picked for patching parallel versions, which is great.

Use [Gitmoji-flavored Comigoji guide](https://comigo.gitlab.io/comigoji/#gitmoji) for naming your commits. One of its features is creating beautiful changelogs!
> Use [Gitmoji-flavored Comigoji guide](https://comigo.gitlab.io/comigoji/#gitmoji) for naming your commits. One of its features is creating beautiful changelogs!
Before sending a merge request, make sure ct.js builds and lints successfully, meaning that commands `gulp build` and `gulp lint` run without errors. Name merge requests in the same fashion as commits.

If you have any problems, ask for help! Add `:construction:` to your pull request's name, link it to relevant issues, so you can get interest from other developers.
24 changes: 17 additions & 7 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
Before sending the pull request, make sure that:

- [ ] `gulp build` runs without issues
- [ ] if you develop a catmod, a test project and docs are also present. Put a test project into a catmod's directory.
- [ ] if it is a work-in-progress, explicitly mark it as such in the title with the `:construction:` prefix.

--------------------------------------------------------
Delete this and everything above this line before posting

Closes #(issue's index).

Changes proposed in this pull request:
**Changes proposed in this pull request:**

-
-
-
-
-
-

Before sending the pull request, make sure that:
**Help wanted:** (optional, e.g. a request for GUI revamp)

- [ ] `gulp build` runs without issues
- [ ] if you develop a catmod, a test project is also present. Put it into a catmod's directory.
-
-
-

**Ping @CosmoMyzrailGorynych**

0 comments on commit b2c52ec

Please sign in to comment.