Thank you for considering contributing to SDC-v3! This project is open to contributions from anyone interested in improving it.
To get started, follow these steps:
- Fork the repository and clone it to your local machine.
- Install the necessary dependencies using
npm install. - Create a new branch for your changes using
git checkout -b new-branch-name. - Make your changes and commit them using
git commit. - Push your changes to your fork using
git push origin new-branch-name. - Open a pull request on the main repository.
Here are a few guidelines to follow when contributing:
- Create a new branch for each contribution. This makes it easier to keep track of changes and to merge them later.
- Make sure your code is well-documented. Comment your code and add documentation where necessary.
- Follow the code style of the project. Take a look at the existing code and try to match its style as closely as possible.
- Test your changes. Make sure your changes don't break existing functionality and that they work as expected.
- Be respectful. Remember that this is an open-source project and that everyone is here to learn and improve.
To contribute to this project, follow these steps:
- Fork this repository by clicking the "Fork" button at the top of the repository page.
- Clone the forked repository to your local machine using the command git clone .
- Create a new branch for your changes using the command git checkout -b .
- Make the necessary changes to the code, and make sure they follow the project's coding style and conventions.
- Commit your changes with a descriptive commit message using the command git commit -m "Descriptive commit message".
- Push your changes to your forked repository using the command git push origin .
- Create a pull request by clicking the "New pull request" button on the forked repository page.
- Wait for the project maintainers to review your pull request and provide feedback.
- Make any necessary changes based on the feedback, and push them to your branch.
- Repeat steps 8 and 9 until your pull request is accepted and merged into the main repository.
To link a pull request from a forked repository to the original repository's issue, you can use a special syntax in the pull request's description or comments. Here are the steps to do this:
- In the pull request's description or comments, type "Fixes #issue-number", where "issue-number" is the number of the issue in the original repository that the pull request is related to.
- Make sure the issue number is preceded by the "#" symbol. For example, if the issue number is "123", you would type "Fixes #123".
- When you submit the pull request, GitHub will automatically link the pull request to the issue in the original repository.
- The pull request will also appear in the "Pull requests" tab of the original repository's issue.
- Here's an example of what the syntax would look like in a pull request comment:
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to the project maintainers at [foresthpark@gmail.com].
This project uses the following technologies:
- Next.js: a React framework for building server-side rendered applications
- tRPC: a TypeScript-first RPC framework for building APIs with strongly-typed contracts
- Tailwind CSS: a utility-first CSS framework for rapidly building custom user interfaces
- Axios: a Promise-based HTTP client for making API requests
- date-fns: a library for working with dates and times in JavaScript
- NextAuth.js: an authentication library for Next.js applications
- react-hook-form: a library for building forms in React
- zod: a TypeScript-first schema validation library
Here are the links to the official documentation for each technology:
If you have any feedback, questions or suggestions, feel free to create a new issue or contact the project maintainers at foresthpark@gmail.com.
Thank you for your contributions!
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.
