Skip to content

Commit 889a7c3

Browse files
dileepadevTharinduX
dileepadev
and
TharinduX
authored
docs: Add community standards (#3)
* docs: Add CODE_OF_CONDUCT.md * docs: Add LICENSE * docs: Add CONTRIBUTING.md * docs: Add bug_report.md * docs: Add feature_request.md * docs: Add documentation_update.md * docs: Add PULL_REQUEST_TEMPLATE.md * docs: Add COMMIT_MESSAGE_GUIDELINES.md * fix: preview link --------- Co-authored-by: Tharindu Jayasanka <[email protected]>
1 parent e355074 commit 889a7c3

File tree

9 files changed

+392
-1
lines changed

9 files changed

+392
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug]: Short description of the issue"
5+
labels: "bug, needs triage"
6+
assignees: "@dileepabandara"
7+
---
8+
9+
## Bug Report
10+
11+
### Description
12+
13+
[Provide a clear and concise description of the bug.]
14+
15+
### Steps to Reproduce
16+
17+
1. [First Step]
18+
2. [Second Step]
19+
3. [and so on...]
20+
21+
### Expected Behavior
22+
23+
[What did you expect to happen?]
24+
25+
### Actual Behavior
26+
27+
[What actually happened?]
28+
29+
### Screenshots
30+
31+
[If applicable, add screenshots to help explain your problem.]
32+
33+
### Environment
34+
35+
[Please add any other relevant information about the bug and remove the unnecessary lines.]
36+
37+
e.g.,
38+
39+
- Operating System: [e.g., Windows, MacOS, Linux]
40+
- Browser: [e.g., Chrome, Firefox, Safari]
41+
- Device: [e.g., iPhone6, Laptop]
42+
- Version: [e.g., 22]
43+
- Other info: [e.g., Display Resolution, Resolution, etc]
44+
45+
### Additional Information
46+
47+
[Add any other information about the problem here. For example, you might include the error message, any recent changes that you made to the project, or any other relevant details.]

‎.github/ISSUE_TEMPLATE/documentation_update.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Documentation update
3+
about: Propose a change to the project documentation
4+
title: "[Docs]: Short description of the change"
5+
labels: "documentation, needs review"
6+
assignees: "@dileepabandara"
7+
---
8+
9+
## Documentation Update
10+
11+
### Description
12+
13+
[Provide a clear and concise description of the documentation update you'd like to see made.]
14+
15+
### Current Documentation
16+
17+
[Provide a link to the current documentation or describe where it can be found.]
18+
19+
### Proposed Documentation
20+
21+
[Provide a clear and concise description of the updated documentation that you'd like to see added.]
22+
23+
### Additional Information
24+
25+
[Add any other information about the documentation update here. For example, you might include links to similar documentation in other projects, or screenshots or diagrams to help explain your idea.]

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest a feature for this project
4+
title: "[Feature Request]: Short description of the feature"
5+
labels: "enhancement, needs triage, feature request"
6+
assignees: "@dileepabandara"
7+
---
8+
9+
## Feature Request
10+
11+
### Description
12+
13+
[Provide a clear and concise description of the feature you'd like to see added.]
14+
15+
### Use Case
16+
17+
[Describe how this feature would be useful to you or to other users of the project.]
18+
19+
### Proposed Solution
20+
21+
[If you have a specific solution in mind, describe it here. If not, you can skip this section.]
22+
23+
### Alternatives
24+
25+
[Are there any alternative solutions or workarounds that you've considered? If so, describe them here.]
26+
27+
### Additional Information
28+
29+
[Add any other information about the feature request here. For example, you might include links to similar features in other projects, or screenshots or diagrams to help explain your idea.]

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Pull Request
2+
3+
**Description**
4+
5+
Briefly describe the changes made in this pull request.
6+
7+
**Related Issue(s)**
8+
9+
If this pull request is related to an issue, please reference it by linking to it (e.g., "Closes #123").
10+
11+
**Checklist**
12+
13+
Before submitting this pull request, please ensure the following:
14+
15+
- [ ] I have read and followed the project's contributing guidelines.
16+
- [ ] My code follows the project's coding style and conventions.
17+
- [ ] My commits follow the project's commit message guidelines.
18+
- [ ] I have reviewed my changes to ensure they are complete and accurate.
19+
20+
**Submission**
21+
22+
Before submitting, please review your pull request to ensure it is complete and follows the provided checklist. Thank you for contributing!

‎.github/workflows/preview.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
DEPLOY_URL=$(echo "$DEPLOY_OUTPUT" | jq -r '.deploy_url')
4444
4545
# Set outputs for later use
46-
echo "{deploy_url}=${DEPLOY_URL}" >> $GITHUB_OUTPUT
46+
echo "deploy_url=${DEPLOY_URL}" >>$GITHUB_OUTPUT
4747
env:
4848
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
4949
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_PREVIEW_SITE_ID }}

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎COMMIT_MESSAGE_GUIDELINES.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Commit Message Guidelines
2+
3+
Good commit messages are essential for maintaining a clean and informative Git history. This document provides guidelines for writing clear and meaningful commit messages in this repository.
4+
5+
## Commit Message Structure
6+
7+
A commit message should have a clear and concise structure:
8+
9+
**``<type>(<scope>): <subject>``**
10+
11+
- `<type>`: Describes the purpose of the commit. Common types include:
12+
- `feat`: A new feature or functionality.
13+
- `fix`: A bug fix.
14+
- `docs`: Documentation changes.
15+
- `style`: Code style changes (e.g., formatting, whitespace).
16+
- `refactor`: Code refactoring without changing functionality.
17+
- `test`: Adding or modifying tests.
18+
- `chore`: Routine tasks, maintenance, or housekeeping.
19+
- `<scope>` (optional): Describes the context or component of the project that the commit affects.
20+
- `<subject>`: A concise one-line description of the commit. It should start with a verb in the imperative mood (e.g., "Fix typo" instead of "Fixed typo" or "Fixes typo").
21+
22+
## Examples
23+
24+
Here are some examples of well-formatted commit messages:
25+
26+
| Type | Commit Message with Scope | Commit Message without Scope |
27+
|------------|-----------------------------------------------------|-----------------------------------------------------|
28+
| `feat` | `feat(user-auth): Add user registration functionality` | `feat: Add user registration functionality` |
29+
| `fix` | `fix(api): Handle null values in response` | `fix: Handle null values in response` |
30+
| `docs` | `docs(readme): Update installation instructions` | `docs: Update installation instructions` |
31+
| `style` | `style(css): Format code according to style guide` | `style: Format code according to style guide` |
32+
| `refactor` | `refactor(database): Optimize query performance` | `refactor: Optimize query performance` |
33+
| `test` | `test(unit): Add tests for authentication` | `test: Add tests for authentication` |
34+
| `chore` | `chore(release): Bump version to 1.0.0` | `chore: Bump version to 1.0.0` |
35+
36+
## Additional Guidelines
37+
38+
- Keep commit messages concise and focused on a single change.
39+
- Use present tense (e.g., "Add feature" not "Added feature").
40+
- Capitalize the first letter of the subject.
41+
- Use imperative mood for the subject (e.g., "Fix bug" not "Fixing bug").
42+
- Use an empty line between the subject and the body (if the body is present).
43+
- Use the body of the commit message to provide additional context and details if necessary.
44+
45+
## Summary
46+
47+
Writing clear and consistent commit messages helps everyone involved in the project understand the purpose and context of each commit. Following these guidelines will lead to a more organized and understandable Git history.

‎CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to nibmcs.org
2+
3+
Thank you for your interest in contributing to [nibmcs.org](https://github.com/nibmcs/nibmcs.org)! We welcome any contributions, including bug fixes, feature enhancements, documentation improvements, and other general improvements.
4+
5+
## Getting Started
6+
7+
1. Fork this repository to your GitHub account. This will create a copy of this repository in your account. You can make changes to this copy without affecting the original repository.
8+
- To fork this repository, click the **Fork** button in the top right corner of this page or click [here](https://github.com/nibmcs/nibmcs.org/fork).
9+
2. Clone your forked repository to your local machine.
10+
- Use the following command to clone your forked repository to your local machine.
11+
12+
```bash
13+
git clone https://github.com/your-username/nibmcs.org.git
14+
```
15+
16+
3. Create a new branch for your changes.
17+
- For example, to create a new branch named `your-branch-name`, use the following command.
18+
19+
```bash
20+
git checkout -b your-branch-name
21+
```
22+
23+
4. Make your changes and commit them with a descriptive commit message.
24+
- For example, to commit your changes, use the following command and make sure to follow the [commit message guidelines](COMMIT_GUIDELINES.md).
25+
26+
```bash
27+
git commit -m "feat: add a new feature"
28+
```
29+
30+
5. Push your changes to your forked repository.
31+
- For example, to push your changes to your forked repository, use the following command.
32+
33+
```bash
34+
git push origin your-branch-name
35+
```
36+
37+
6. Submit a **pull request** to the upstream repository.
38+
- For example, to create a pull request, use the following steps.
39+
1. Go to your forked repository.
40+
2. Click the **Compare & pull request** button next to your `your-branch-name` branch.
41+
3. Add a title and description for your pull request.
42+
4. Click **Create pull request** and remember to add the relevant labels using the [pull request template](.github/PULL_REQUEST_TEMPLATE.md).
43+
44+
## Guidelines
45+
46+
- Follow the code style of the project.
47+
- Update the **documentation** if necessary.
48+
- Add tests if applicable.
49+
- Make sure all tests pass before submitting your changes.
50+
- Keep your pull request focused and avoid including unrelated changes.
51+
- Remember to follow the given files before submitting your changes:
52+
- [bug_report.md](.github/ISSUE_TEMPLATE/bug_report.md) - Use this template to create a report to help us improve.
53+
- [feature_request.md](.github/ISSUE_TEMPLATE/feature_request.md) - Use this template to suggest a feature for this project.
54+
- [documentation_update.md](.github/ISSUE_TEMPLATE/documentation_update.md) - Use this template to propose a change to the documentation.
55+
- [custom.md](.github/ISSUE_TEMPLATE/custom.md) - Use this template to submit a custom issue.
56+
- [PULL_REQUEST_TEMPLATE.md](.github/PULL_REQUEST_TEMPLATE.md) - Use this template to submit a pull request.
57+
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Read this file to learn about the code of conduct.
58+
- [COMMIT_MESSAGE_GUIDELINES.md](COMMIT_MESSAGE_GUIDELINES.md) - Read this file to learn about the commit message guidelines.
59+
- [CONTRIBUTING.md](CONTRIBUTING.md) - Read this file to learn about the contributing guidelines.
60+
- [LICENSE](LICENSE) - Read this file to learn about the license.
61+
- [README.md](README.md) - Read this file to learn about the project.
62+
- [SECURITY.md](SECURITY.md) - Read this file to learn about the security policy.
63+
64+
## Code of Conduct
65+
66+
Please note that this project adheres to the **Contributor Covenant Code of Conduct**. By participating in this project, you agree to abide by its terms.
67+
68+
Read the full code of conduct [here](CODE_OF_CONDUCT.md).
69+
70+
## Contact
71+
72+
If you have any questions, feel free to contact us via email at <[email protected]>.

0 commit comments

Comments
 (0)