mirror of
https://github.com/CorsixTH/CorsixTH.git
synced 2025-07-23 04:13:01 +02:00
[RDY] Update PR template and Contributing (#1976)
Github Projects can be utilised by contributors now to point their own PRs into specific projects. This helps with looking over at the end of a round to make release notes. There are also new PR Labels to help classify PRs too. Reformat and update Contributing Guidelines Co-authored-by: Alberth289346 <alberth289346@gmail.com>
This commit is contained in:
lewri
GitHub
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
<!-- If your PR is still being drafted you must either submit it as a "Draft Pull Request" or add [WIP] to your title. -->
|
||||||
|
|
||||||
*Fixes #*
|
*Fixes #*
|
||||||
|
|
||||||
**Describe what the proposed change does**
|
**Describe what the proposed change does**
|
||||||
|
|||||||
132
CONTRIBUTING.md
Normal file
132
CONTRIBUTING.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
# CorsixTH Contributing Guidelines #
|
||||||
|
|
||||||
|
## Tell other devs what you are working on! ##
|
||||||
|
|
||||||
|
When you start working on a fix/enhancement for an open issue always post a
|
||||||
|
comment in this issue's discussion to tell other devs that you have started
|
||||||
|
working on it so that they won't waste any of their free time by working on
|
||||||
|
their own fix/enhancement for it.
|
||||||
|
|
||||||
|
If there isn't an open issue for a bug fix/enhancement you want to work on
|
||||||
|
please check that one wasn't closed by a previous developer who didn't finish
|
||||||
|
their work, which you could finish.
|
||||||
|
|
||||||
|
And if there is no existing issue the bug fix or feature you plan to contribute
|
||||||
|
open a new issue for it and tell other devs here that your going to/have
|
||||||
|
started working on it.
|
||||||
|
|
||||||
|
**If you have an idea for an enhancement that does not have a discussion, make
|
||||||
|
a *Feature Request* first to discuss its desirability. This helps make sure
|
||||||
|
your development time is a worthy endeavour.**
|
||||||
|
|
||||||
|
## Enhancement/Suggestions ##
|
||||||
|
|
||||||
|
To suggest an enhancement, open a new [issue](https://github.com/CorsixTH/CorsixTH/issues/new/choose) and click the *Feature Request*
|
||||||
|
button. It will provide all the information needed to evaluate the
|
||||||
|
suggestion or enhancement.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Pull Requests ##
|
||||||
|
|
||||||
|
When providing a pull request ensure the description field describes the major
|
||||||
|
changes from the request. If your pull request relates to any existing issues,
|
||||||
|
link those issues to the description by referencing them with a `#` followed by the issue number.
|
||||||
|
The pull request provides a default layout to help you fill out this information.
|
||||||
|
|
||||||
|
#### Pull Request Statuses ####
|
||||||
|
CorsixTH encourages using the following labels inside your Pull Request's title
|
||||||
|
to denote its current progress. Unlabelled pull request will be considered
|
||||||
|
*Ready* and may be merged without warning.
|
||||||
|
| Label | Description |
|
||||||
|
| ----- | ----------- |
|
||||||
|
| **[WIP]** | Work in Progress |
|
||||||
|
| **[RFC]** | (Optional stage) Request for Comments (aka Ready for Review) |
|
||||||
|
| ***\<none>*** | Ready |
|
||||||
|
|
||||||
|
Please make sure you label and update your Pull Request accordingly.
|
||||||
|
You can also submit a **Draft Pull Request** as an alternative to the
|
||||||
|
**[WIP]** label.
|
||||||
|
|
||||||
|
|
||||||
|
#### CONTRIBUTING CODE: ####
|
||||||
|
**Important!**\
|
||||||
|
Ensure you have read our [Coding Conventions](https://github.com/CorsixTH/CorsixTH/wiki/Coding-Conventions)
|
||||||
|
before starting your work. CorsixTH may use styles different to your previous experience with ``Lua``
|
||||||
|
and ``C++``. The [Wiki](https://github.com/CorsixTH/CorsixTH/wiki/) also contains other useful information
|
||||||
|
that could be beneficial before contributing code.
|
||||||
|
|
||||||
|
*NB: If you're using GitHub Desktop ignore the git specific commands and follow
|
||||||
|
guidance from [GitHub Docs](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)*\
|
||||||
|
**First Time**
|
||||||
|
1. Ensure you have a GitHub account (https://github.com/signup/free)
|
||||||
|
2. Fork CorsixTH\CorsixTH (https://github.com/CorsixTH/CorsixTH/fork)
|
||||||
|
3. Ensure you have a git client. ([GitHub Desktop](http://desktop.github.com)
|
||||||
|
[Interactive] | [Git](https://git-scm.com/downloads) [Shell])
|
||||||
|
4. Fork the CorsixTH/CorsixtTH project to your account, the CorsixtTH/CorsixtTH
|
||||||
|
project page has a button for this.
|
||||||
|
5. Clone your fork to your computer
|
||||||
|
- ``git clone https://github.com/mygithubuser/CorsixTH.git``
|
||||||
|
6. Add upstream remote
|
||||||
|
- ``git remote add upstream https://github.com/CorsixTH/CorsixTH.git``
|
||||||
|
|
||||||
|
**Every Time**
|
||||||
|
1. Sync your master branch with the CorisxTH repository's master branch
|
||||||
|
- ``git checkout master``
|
||||||
|
- ``git fetch upstream``
|
||||||
|
- ``git merge --ff-only upstream/master``
|
||||||
|
2. Make sure no one is already working on the issue you want to work on.
|
||||||
|
3. Tell other developers that you've started/will start working on this issue
|
||||||
|
by posting a comment in its existing issue discussion or if there's no existing
|
||||||
|
discussion for it then please open a new issue discussion for it and tell other
|
||||||
|
devs here that your working on it.
|
||||||
|
4. Create feature branch from your master
|
||||||
|
- ``git branch myfeature master``
|
||||||
|
5. Checkout your feature branch
|
||||||
|
- ``git checkout myfeature``
|
||||||
|
6. Make your changes
|
||||||
|
7. Unittest continuously, see README.txt in CorsixTH/Luatest for more info
|
||||||
|
8. Review, add, and commit your changes.\
|
||||||
|
Note: ``C++`` code must be formatted using ``clang-format`` before it will be accepted
|
||||||
|
- ``git diff`` | See your changes.
|
||||||
|
- ``git diff --check`` | Check there's no white space.
|
||||||
|
- ``git add`` | do this for each file
|
||||||
|
- ``git commit`` | Write an informative commit message and save.
|
||||||
|
9. Push your changes to your fork
|
||||||
|
- ``git push origin myfeature``
|
||||||
|
9. Create a Pull Request -- GitHub will pick up your latest branch committed to
|
||||||
|
automatically when accessing CorsixTH/CorsixTH.
|
||||||
|
|
||||||
|
The developers will review and report any changes needed to your Pull Request
|
||||||
|
so it could be accepted.
|
||||||
|
|
||||||
|
#### Notes ####
|
||||||
|
##### Multiple commits: #####
|
||||||
|
If your pull request can not be summarised in a single sentence, break it into smaller steps
|
||||||
|
and do a separate commit for every independent operation (e.g. one sentence per commit is a
|
||||||
|
good measure). This means doing step 10 several times as you go. You still only need to do
|
||||||
|
one pull request at the end.
|
||||||
|
|
||||||
|
##### Syncing with Upstream: #####
|
||||||
|
If it takes a long time between when you start your feature and when you finish
|
||||||
|
there might be other important changes other people are making to CorsixTH. To
|
||||||
|
ensure your pull request operates correctly within the latest changes:
|
||||||
|
- Commit your work to the feature branch
|
||||||
|
- ``git checkout master``
|
||||||
|
- ``git fetch upstream``
|
||||||
|
- ``git merge --ff-only master``
|
||||||
|
- ``git checkout myfeature`` | switch back to your feature branch to continue
|
||||||
|
working on it
|
||||||
|
|
||||||
|
*NB: GitHub Desktop users need to conduct fetch upstream from your branch on
|
||||||
|
github.com and rebase from GitHub Desktop after*\
|
||||||
|
This downloads all the changes from CorsixTH/CorsixTH since you
|
||||||
|
started, and moves your commits on top of them. If there are
|
||||||
|
conflicts, for example if someone else changed the same line in the same file
|
||||||
|
that you did you will be asked to resolve those conflicts.
|
||||||
|
|
||||||
|
If you follow these guidelines then you should be well on your way to producing
|
||||||
|
good pull requests.
|
||||||
|
|
||||||
|
If you need more help get in touch at our [Discord Server](https://discord.gg/Mxeztvh) or via [Matrix](https://matrix.to/#/#corsixth-general:matrix.org).
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
TELL OTHER DEVS WHAT YOU ARE WORKING ON
|
|
||||||
|
|
||||||
When you start working on a fix/enhancement for an open issue please always
|
|
||||||
post a comment in this issue's discussion to tell other devs that you have
|
|
||||||
started working on it so that they won't waste any of their free time by
|
|
||||||
working on their own fix/enhancement for it.
|
|
||||||
|
|
||||||
If there isn't an open issue discussion for a bug fix/enhancement you want
|
|
||||||
to work on please check that there isn't a closed discussion for it because
|
|
||||||
a previous developer of it didn't finish their work which you could finish.
|
|
||||||
|
|
||||||
And if there is no existing issue discussion for what you want to work on
|
|
||||||
please open a new issue for it and tell other devs here that your going to/
|
|
||||||
have started working on it.
|
|
||||||
|
|
||||||
SUGGESTION
|
|
||||||
|
|
||||||
If you want to make a suggestion, please copy the following questions into
|
|
||||||
your issue and answer them:
|
|
||||||
|
|
||||||
What is it you would like in the game?
|
|
||||||
|
|
||||||
What version of the product are you using? On what operating system?
|
|
||||||
|
|
||||||
PULL REQUEST
|
|
||||||
|
|
||||||
When providing a pull request ensure the description field describes the major
|
|
||||||
changes from the request. If your pull request relates to any existing
|
|
||||||
issues, include those issues in the description. e.g. "Fixes issue #1"
|
|
||||||
|
|
||||||
|
|
||||||
CONTRIBUTING CODE:
|
|
||||||
|
|
||||||
First Time
|
|
||||||
1. Ensure you have a GitHub account (https://github.com/signup/free)
|
|
||||||
2. Fork CorsixTH\CorsixTH (https://github.com/CorsixTH/CorsixTH/fork)
|
|
||||||
3. Ensure you have a git client. (http://desktop.github.com)
|
|
||||||
4. Clone your fork to your computer
|
|
||||||
- If using github client, run Git Shell
|
|
||||||
- git clone https://github.com/mygithubuser/CorsixTH.git
|
|
||||||
5. Add upstream remote
|
|
||||||
- git remote add upstream https://github.com/CorsixTH/CorsixTH.git
|
|
||||||
|
|
||||||
Every Time
|
|
||||||
6. Sync your master branch with the CorisxTH repository's master branch
|
|
||||||
- git fetch upstream
|
|
||||||
- git rebase upstream/master
|
|
||||||
7. Make sure no one is already working on the issue you want to work on.
|
|
||||||
8. Tell other developers that you've started/will start working on this issue
|
|
||||||
by posting a comment in its existing issue discussion or if there's no existing
|
|
||||||
discussion for it then please open a new issue discussion for it and tell other
|
|
||||||
devs here that your working on it.
|
|
||||||
9. Create feature branch
|
|
||||||
- git branch myfeature upstream/master
|
|
||||||
10. Checkout your feature branch
|
|
||||||
- git checkout myfeature
|
|
||||||
11. Make your changes
|
|
||||||
12. Unittest continuously, see README.txt in CorsixTH/Luatest for more info
|
|
||||||
13. Review your changes
|
|
||||||
- git diff
|
|
||||||
(each file) - git add
|
|
||||||
- git diff --check
|
|
||||||
Check there's no white spaces.
|
|
||||||
- git commit
|
|
||||||
Write an informative commit message and save
|
|
||||||
14. Push your changes to your fork
|
|
||||||
- git push origin myfeature
|
|
||||||
15. Create a pull request
|
|
||||||
(https://github.com/mygithubuser/CorsixTH/compare/CorsixTH:master...myfeature)
|
|
||||||
|
|
||||||
Now watch to see if your feature is accepted.
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
Multiple commits:
|
|
||||||
If your feature is very big, break it into subprojects and do a separate commit
|
|
||||||
for every independent operation. This means doing step 10 several times as you
|
|
||||||
go. You still only need to do one pull request at the end.
|
|
||||||
|
|
||||||
Syncing with Upstream:
|
|
||||||
If it takes a long time between when you start your feature and when you finish
|
|
||||||
there might be other important changes other people are making to CorsixTH. It
|
|
||||||
is a good idea to make sure your code will still operate correctly with the
|
|
||||||
latest changes. To do this:
|
|
||||||
- git fetch upstream
|
|
||||||
- git rebase upstream/master
|
|
||||||
What this does is downloads all the changes from CorsixTH\CorsixTH since you
|
|
||||||
started, and pretends that all your changes were made after them. If there are
|
|
||||||
conflicts, for example if someone else changed the same line in the same file
|
|
||||||
that you did you will be asked to resolve those conflicts.
|
|
||||||
|
|
||||||
If you follow these guidelines then you should be well on your way to producing
|
|
||||||
good pull requests.
|
|
||||||
|
|
||||||
If you need more help just ask the friendly people on
|
|
||||||
corsix-th-dev@googlegroups.com or via IRC in #corsix-th on freenode.
|
|
||||||
Reference in New Issue
Block a user