Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add various PR guidelines to the README #752

Open
petertseng opened this issue Oct 31, 2018 · 2 comments
Open

add various PR guidelines to the README #752

petertseng opened this issue Oct 31, 2018 · 2 comments

Comments

@petertseng
Copy link
Member

I expect that the main party motivated to actually fix this issue will be the maintainers of this repo, so I intend this issue as mostly a reminder that the maintainers should do so.

There are various guidelines such as:

  • If a commit affects one exercise, prefix the commit message with that exercise's name. Do something similar if the commit affects one clear area of the repository.
  • If the PR follows a problem-specifications change, link to the relevant PRs from problem-specifications.
  • If amending commits while PR is in review, it's helpful to include a verbal explanation of what changed. No preference between amending versus just adding new commits.
  • Mention https://help.github.com/articles/closing-issues-using-keywords/
  • Each commit should make a single logical change. Maintainers do have the ability to squash every commit in a PR into one commit when merging, and we use that ability when it is appropriate. If the PR should instead be multiple commits, maintainers might choose to manually arrange the changes into the appropriate commits or ask the submitter to do so. Submitters should feel free to speak up about any preferences or suggestions as to whether the final product should be one commit or multiple.

Should add those in some appropriate location.

@petertseng
Copy link
Member Author

config.json "The sequence order is also the default order in which the exercises are fetched." - this is false w/ the tree structure. Core exercises need to be ordered specifically, the rest we'll order by difficulty just so that we have some semblance of order. We'll put all core exercises before all non-core exercises in the JSON file so they're easily visible.

@sshine sshine pinned this issue Mar 18, 2019
@sshine
Copy link
Contributor

sshine commented Mar 18, 2019

I've pinned this issue until these changes are merged into the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants