Skip to content

Development #26

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

Merged
merged 5 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### Description
Please explain the changes you made here.

### Checklist
- [ ] Code compiles correctly
- [ ] Code is formatted using the correct coding style
- [ ] Created tests which fail without the change (if possible)
- [ ] All tests passing
- [ ] Extended the README / documentation, if necessary
- [ ] Added myself / the copyright holder to the AUTHORS file
16 changes: 16 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# This is the official list of Spynix authors for copyright purposes.

# If you are submitting a patch, please add your name or the name of the
# organization which holds the copyright to this list in alphabetical order.

# Names should be added to this file as
# Name <email address>
# The email address is not required for organizations.
# Please keep the list sorted.


# Individual Persons

Andrew Kushyk <akushyk799 at gmail.com>

# Organizations
22 changes: 22 additions & 0 deletions doc/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Contributing Guidelines
=======================

Reporting Issues
----------------

- Before creating a new Issue, please check first if a similar Issue already exists https://github.com/git-user-cpp/spynix/issues?state=open or was recently closed https://github.com/git-user-cpp/spynix/issues?direction=desc&page=1&sort=updated&state=closed

Contributing Code
-----------------

- By contributing to this project, you share your code under the Apache License Version 2.0, as specified in the LICENSE file.
- Follow instructions and code style from https://github.com/git-user-cpp/spynix/blob/main/doc/CODE_STYLE.rst
- Don't forget to add yourself to the AUTHORS file.

Code Review
-----------

- Everyone is invited to review and comment on pull requests.
- If it looks fine to you, comment with "LGTM" (Looks good to me).
- If changes are required, notice the reviewers with "PTAL" (Please take another look) after committing the fixes.
- Before merging the Pull Request, at least one team member must have commented with "LGTM".