Added CONTRIBUTING.md for contribution guidelines

hoangsonww · Jan 3, 2024 · 6eaedb9 · 6eaedb9
1 parent df7438b
commit 6eaedb9
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,73 @@
+# Contributing to StickyNotes App
+
+First and foremost, thank you for considering contributing to StickyNotes App! Your time and skills are valuable to us, and we appreciate any help you can provide to make this app better for everyone. Whether you're fixing a bug, adding a new feature, or improving the documentation, your contribution is essential.
+
+## Code of Conduct
+
+Our community is dedicated to providing a harassment-free experience for everyone. We do not tolerate harassment of community members in any form. Please refer to our Code of Conduct for complete details.
+
+## Getting Started
+
+Before you begin, please ensure you have a GitHub account and have familiarized yourself with the [GitHub flow](https://guides.github.com/introduction/flow/). This will involve creating a branch, making changes, submitting a pull request, and reviewing and discussing these changes.
+
+### Reporting Bugs
+
+Bugs are tracked as GitHub issues. To report a bug, please follow these guidelines:
+
+1. **Use the GitHub issue search** to check if the issue has already been reported.
+2. If the issue is unreported, **open a new issue**. Provide a **clear title and description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for StickyNotes App, including completely new features and minor improvements to existing functionality.
+
+1. **Use the GitHub issue search** to check if the enhancement has already been suggested.
+2. If it hasn't, **open a new issue**. Provide a **clear title and description**, as detailed as possible and if possible, include **examples** of how the enhancement would work.
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to StickyNotes App? Look for the `good first issue` label in the issues section, which is a great start for newcomers.
+
+### Pull Requests
+
+1. **Fork** the repo and **create your branch** from `main`.
+2. **Make your changes** and ensure they meet the project standards.
+3. **Write or adapt tests** as needed.
+4. **Ensure your code lints** (if applicable).
+5. **Issue that pull request!**
+
+## Styleguides
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature").
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+- Limit the first line to 72 characters or less.
+- Reference issues and pull requests liberally after the first line.
+
+### JavaScript Styleguide
+
+All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/).
+
+### CSS/HTML Styleguide
+
+- Use soft tabs with two spaces—they're the only way to guarantee code renders the same in any environment.
+- Use HTML5 doctype (`<!DOCTYPE html>`).
+- Avoid inline styles where possible.
+
+## Additional Notes
+
+### Issue and Pull Request Labels
+
+This section lists the labels we use to help us track and manage issues and pull requests.
+
+- **`good first issue`** – Good for newcomers.
+- **`bug`** – Something isn't working.
+- **`enhancement`** – New feature or request.
+- **`help wanted`** – Extra attention is needed.
+
+## Conclusion
+
+Contributions to StickyNotes App are greatly appreciated and vital for its continuous development. By participating in this project, you agree to abide by its terms. Thank you for your contributions – happy coding!
+
+---
diff --git a/README.md b/README.md
@@ -83,6 +83,10 @@ The StickyNotes App is a dynamic, user-friendly web application that allows user
 - More advanced data management features including cloud storage and data encryption.
 - More advanced note-taking features including drawing and handwriting recognition.
 
+## Contributing
+
+If you're interested in contributing to the StickyNotes App, please read our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get started.
+
 ## Support and Feedback
 
 For support, feedback, or contributions, please refer to the GitHub repository's issues section or contact the developer directly.