Skip to content

Commit 7b53a0b

Browse files
committed
Cleanup: remove CHANGELOG and PR template, streamline CONTRIBUTING
1 parent f8666a2 commit 7b53a0b

File tree

3 files changed

+25
-144
lines changed

3 files changed

+25
-144
lines changed

CHANGELOG.md

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

CONTRIBUTING.md

Lines changed: 25 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,37 @@
1-
Contributing Guidelines
2-
--------------------------------------------------
1+
# Contributing Guidelines
32

4-
This document provides general guidelines about how to contribute to the project. Keep in mind these important things before you start contributing.
3+
Thanks for your interest in contributing to SwiftDataTables!
54

6-
### Reporting issues
5+
## Reporting Bugs
76

8-
* Use [github issues](https://github.com/pavankataria/SwiftDataTables/issues) to report a bug.
9-
* Before creating a new issue:
10-
* Make sure you are using the [latest release](https://github.com/pavankataria/SwiftDataTables/releases).
11-
* Check if the issue was [already reported or fixed](https://github.com/pavankataria/SwiftDataTabes/issues?utf8=%E2%9C%93&q=is%3Aissue). Notice that it may not be released yet.
12-
* If you found a match add a brief comment "I have the same problem" or "+1". This helps prioritize the issues addressing the most common and critical first. If possible add additional information to help us reproduce and fix the issue. Please use your best judgement.
13-
* Reporting issues:
14-
* Please include the following information to help maintainers to fix the problem faster:
15-
* Xcode version you are using.
16-
* iOS version you are targeting.
17-
* Full Xcode console output of stack trace or code compilation error.
18-
* Any other additional detail you think it would be useful to understand and solve the problem.
7+
Use [GitHub Issues](https://github.com/pavankataria/SwiftDataTables/issues) to report bugs.
198

9+
Before creating a new issue:
10+
- Make sure you're using the [latest release](https://github.com/pavankataria/SwiftDataTables/releases)
11+
- Check if it was [already reported](https://github.com/pavankataria/SwiftDataTables/issues?q=is%3Aissue)
2012

21-
### Pull requests
13+
When reporting, include:
14+
- Xcode and iOS versions
15+
- Full console output or stack trace
16+
- Steps to reproduce
2217

23-
The easiest way to start contributing is searching open issues by `help wanted` tag.
18+
## Feature Requests
2419

25-
* Add test coverage to the feature or fix. We only accept new feature pull requests that have related test coverage. This allows us to keep the library stable as we move forward.
26-
* Remember to document the new feature. We do not accept new feature pull requests without its associated documentation.
27-
* In case of a new feature please update the example project showing the feature.
28-
* Please only one fix or feature per pull request. This will increase the chances your feature will be merged.
20+
**[Vote for features](https://swiftdatatables.pavankataria.com/vote)** — your votes shape the roadmap.
2921

22+
## Pull Requests
3023

31-
###### Suggested git workflow to contribute
24+
Look for issues tagged `help wanted` to get started.
3225

33-
1. Fork the SwiftDataTables repository.
34-
2. Clone your forked project into your developer machine: `git clone git@github.com:<your-github-username>/SwiftDataTables.git`
35-
3. Add the original project repo as upstream repository in your forked project: `git remote add upstream git@github.com:pavankataria/SwiftDataTables.git`
36-
4. Before starting a new feature make sure your forked master branch is synchronized upstream master branch. Considering you do not merge your pull request into master you can run: `git checkout master` and then `git pull upstream master`. Optionally `git push origin master`.
37-
5. Create a new branch. Note that the starting point is the upstream master branch HEAD. `git checkout -b my-feature-name`
38-
6. Stage all your changes `git add .` and commit them `git commit -m "Your commit message"`
39-
7. Make sure your branch is up to date with upstream master, `git pull --rebase upstream master`, resolve conflicts if necessary. This will move your commit to the top of git stack.
40-
8. Squash your commits into one commit. `git rebase -i HEAD~6` considering you did 6 commits.
41-
9. Push your branch into your forked remote repository.
42-
10. Create a new pull request adding any useful comment.
26+
- One fix or feature per PR
27+
- Add tests if possible
28+
- Update the example project for new features
29+
- Document any new APIs
4330

31+
### Workflow
4432

45-
### Feature proposal
46-
47-
We would love to hear your ideas and make a discussions about it.
48-
49-
* Use github issues to make feature proposals.
50-
* We use `feature request` label to mark all [feature request issues](https://github.com/pavankataria/SwiftDataTables/labels/feature%20request).
51-
* Before submitting your proposal make sure there is no similar feature request. If you found a match feel free to join the discussion or just add a brief "+1" if you think the feature is worth implementing.
52-
* Be as specific as possible providing a precise explanation of feature request so anyone can understand the problem and the benefits of solving it.
33+
1. Fork and clone the repo
34+
2. Create a feature branch: `git checkout -b my-feature`
35+
3. Make your changes and commit
36+
4. Rebase on master: `git pull --rebase upstream master`
37+
5. Push and open a PR

PULL_REQUEST_TEMPLATE.md

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

0 commit comments

Comments
 (0)